Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
Menu
Open sidebar
csst-pipeline
csst_proto
Commits
fd859e1e
Commit
fd859e1e
authored
Sep 16, 2023
by
BO ZHANG
🏀
Browse files
tweaks
parent
cf2c31a6
Pipeline
#1208
failed with stage
in 0 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
docs/source/api/csst_proto.rst
View file @
fd859e1e
...
...
@@ -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:
...
...
docs/source/ch04_codestyle.rst
View file @
fd859e1e
...
...
@@ -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,
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment