docs: update setup docs

cryotools · Dec 3, 2024 · 0dc119a · 0dc119a
1 parent 94e6f21
commit 0dc119a
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/cosipy/tests/conftest.py b/cosipy/tests/conftest.py
@@ -74,11 +74,11 @@ def conftest_hide_plot():
 
 
 @pytest.fixture(name="conftest_rng_seed", scope="function", autouse=False)
-def fixture_conftest_rng_seed() -> np.random.Generator:
+def fixture_conftest_rng_seed():
     """Set seed for random number generator to 444.
 
     Returns:
-        Random number generator with seed=444.
+        np.random.Generator: Random number generator with seed=444.
     """
 
     random_generator = np.random.default_rng(seed=444)

diff --git a/.../utilities/cosipy.utilities.setup_cosipy.setup_cosipy.get_user_confirmation.rst b/.../utilities/cosipy.utilities.setup_cosipy.setup_cosipy.get_user_confirmation.rst
@@ -0,0 +1,6 @@
+get\_user\_confirmation
+=======================
+
+.. currentmodule:: cosipy.utilities.setup_cosipy.setup_cosipy
+
+.. autofunction:: get_user_confirmation
diff --git a/docs/source/utilities/cosipy.utilities.setup_cosipy.setup_cosipy.rst b/docs/source/utilities/cosipy.utilities.setup_cosipy.setup_cosipy.rst
@@ -1,4 +1,4 @@
-setup\_cosipy
+setup\_cosipy
 =============
 
 .. currentmodule:: cosipy.utilities.setup_cosipy
@@ -21,8 +21,8 @@ setup\_cosipy
       copy_file_to_target
       get_sample_directory
       get_user_arguments
+      get_user_confirmation
       main
-      strtobool
 
 
 

diff --git a/docs/source/utilities/cosipy.utilities.setup_cosipy.setup_cosipy.strtobool.rst b/docs/source/utilities/cosipy.utilities.setup_cosipy.setup_cosipy.strtobool.rst