Skip to content
GitLab
Commit fd859e1e authored by BO ZHANG's avatar BO ZHANG 🏀
Browse files

tweaks

parent cf2c31a6
Pipeline #1208 failed with stage
in 0 seconds
Hide whitespace changes
Inline Side-by-side
docs/source/api/csst_proto.rst
View file @ fd859e1e
...@@ -4,7 +4,7 @@ API ...@@ -4,7 +4,7 @@ API
In this chapter, we show what the rendered Numpy-style docstring looks like In this chapter, we show what the rendered Numpy-style docstring looks like
in sphinx documentation. in sphinx documentation.
.. automodule:: csst_proto.top_level_interface .. automodule:: csst_proto.api
:noindex: :noindex:
:members: :members:
:undoc-members: :undoc-members:
......
docs/source/ch04_codestyle.rst
View file @ fd859e1e
...@@ -96,7 +96,7 @@ In our case, we recommend the following method to check docstring ...@@ -96,7 +96,7 @@ In our case, we recommend the following method to check docstring
.. code-block:: bash .. 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, For example,
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment