add docstrings

Author: AndyEveritt

DuetWebAPI/api/base.py

@@ -9,28 +9,37 @@ def __init__(self, base_url) -> None:
         self._base_url = base_url
 
     def get_model(self, key: str = None) -> Dict:
+        """ Get Duet object model. RRF3 only """
         raise NotImplementedError
 
     def post_code(self, code: str) -> Dict:
+        """ Send G/M/T-code to Duet """
         raise NotImplementedError
 
     def get_file(self, filename: str, directory: str = 'gcodes') -> str:
+        """ Get file from Duet """
         raise NotImplementedError
 
     def put_file(self, file: str, directory: str = 'gcodes') -> Dict:
+        """ Upload file to Duet """
         raise NotImplementedError
 
     def get_fileinfo(self, filename: str = None, directory: str = 'gcodes') -> Dict:
+        """ Get file info """
         raise NotImplementedError
 
     def delete_file(self, filename: str, directory: str = 'gcodes') -> Dict:
+        """ Delete file on Duet """
         raise NotImplementedError
 
     def move_file(self, from_path: str, to_path: str, force: bool = False) -> Dict:
+        """ Move file on Duet, can be used to rename files """
         raise NotImplementedError
 
     def get_directory(self, directory: str) -> List[Dict]:
+        """ Get a list of all the files & directories in a directory """
         raise NotImplementedError
 
     def put_directory(self, directory: str) -> Dict:
+        """ Create a new directory """
         raise NotImplementedError

examples.py

@@ -8,7 +8,6 @@
 riley = DWA('http://riley')
 force_rig = DWA('http://forcerig')
 
-
 force_rig.put_file('test.gcode')
 riley.put_file('test.gcode')
 pass