Improve docstrings for sphinx.

[python_utils.git] / orb_utils.py

diff --git a/orb_utils.py b/orb_utils.py
index f1d0ee0d9c781cc418231d39b49e8b9320a2ed7a..e6b06a6c744ce9d91eef76268862b08a62e89a32 100644 (file)
--- a/orb_utils.py
+++ b/orb_utils.py
@@ -29,6 +29,7 @@ parser.add_argument(
 
 
 def make_orb(color: str) -> None:
+    """Make the orb on my desk a particular color."""
     user_machine = config.config['orb_utils_user_machine']
     orbfile_path = config.config['orb_utils_file_location']
     os.system(f"ssh {user_machine} 'echo \"{color}\" > {orbfile_path}'")