Add docstrings to acquire.pyi (#198)

This allows the documentation to be automatically added to the web pages at https://acquire-project.github.io/acquire-docs/api_reference/ These docstrings were initially added to the documentation manually by @dgmccart . I reworded some to avoid duplication and organize it but otherwise it is the same content. --------- Co-authored-by: dgmccart <[email protected]> Co-authored-by: Alan Liddell <[email protected]>
acquire-project · Jul 25, 2024 · 40d84e8 · 40d84e8
1 parent ee53640
commit 40d84e8
Show file tree

Hide file tree

Showing 2 changed files with 1,091 additions and 134 deletions.
diff --git a/python/acquire/__init__.py b/python/acquire/__init__.py
@@ -49,6 +49,8 @@ def setup(
     storage: Union[str, List[str]] = "Tiff",
     output_filename: Optional[str] = "out.tif",
 ) -> Properties:
+    """Set up the runtime with a camera and storage device."""
+
     def normalize_fallback_arg(arg: Union[str, List[str]]) -> List[str]:
         if isinstance(arg, str):
             return [arg]