tweaks

fd859e1e · BO ZHANG · cf2c31a6 · fd859e1e · fd859e1e
Commit fd859e1e authored 1 year ago by BO ZHANG
Hide whitespace changes
Inline Side-by-side

Showing

with 2 additions and 2 deletions
+2 -2
--- a/docs/source/api/csst_proto.rst
+++ b/docs/source/api/csst_proto.rst
@@ -4,7 +4,7 @@ API
 In this chapter, we show what the rendered Numpy-style docstring looks like
 in sphinx documentation.

-.. automodule:: csst_proto.top_level_interface
+.. automodule:: csst_proto.api
   :noindex:
   :members:
   :undoc-members:

--- a/docs/source/ch04_codestyle.rst
+++ b/docs/source/ch04_codestyle.rst
@@ -96,7 +96,7 @@ In our case, we recommend the following method to check docstring

 .. code-block:: bash

-    python -m numpydoc --validate {YOUR_PACKAGE}.top_level_interface.{YOUR_FUNCTION/CLASS}
+    python -m numpydoc --validate {YOUR_PACKAGE}.api.{YOUR_FUNCTION/CLASS}

 For example,