Skip to content
GitLab
Explore
Projects
Groups
Snippets
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
be848da4
Commit
be848da4
authored
2 years ago
by
BO ZHANG
Browse files
Options
Download
Email Patches
Plain Diff
added example.py
parent
3e19abcb
dev
main
No related merge requests found
Pipeline
#69
passed with stages
in 13 seconds
Changes
2
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+1
-0
README.md
examples/how_to_write_docstring.py
+5
-0
examples/how_to_write_docstring.py
with
6 additions
and
0 deletions
+6
-0
README.md
+
1
-
0
View file @
be848da4
...
@@ -118,6 +118,7 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f
...
@@ -118,6 +118,7 @@ The `csst_proto` uses an awesome algorithm based on `numpy.ndarray` indices to f
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- Numpydoc: https://numpydoc.readthedocs.io/en/latest/format.html
- for C: https://peps.python.org/pep-0007/
- for C: https://peps.python.org/pep-0007/
- for Python: https://peps.python.org/pep-0008/
- for Python: https://peps.python.org/pep-0008/
- example.py: https://numpydoc.readthedocs.io/en/latest/example.html#example
- `unittest`: https://docs.python.org/3.8/library/unittest.html
- `unittest`: https://docs.python.org/3.8/library/unittest.html
- gitlab CI/CD pipeline: https://docs.gitlab.com/ee/ci/pipelines/
- gitlab CI/CD pipeline: https://docs.gitlab.com/ee/ci/pipelines/
- gitlab runners: https://docs.gitlab.com/runner/
- gitlab runners: https://docs.gitlab.com/runner/
...
...
This diff is collapsed.
Click to expand it.
examples/how_to_write_docstring.py
+
5
-
0
View file @
be848da4
...
@@ -34,5 +34,10 @@ def cos(x: float = 0.) -> float:
...
@@ -34,5 +34,10 @@ def cos(x: float = 0.) -> float:
Notes
Notes
-----
-----
this function is a warpper of `numpy.cos()`
this function is a warpper of `numpy.cos()`
Conf
----
https://numpydoc.readthedocs.io/en/latest/example.html#example
"""
"""
return
np
.
cos
(
x
)
return
np
.
cos
(
x
)
This diff is collapsed.
Click to expand it.
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
Menu
Explore
Projects
Groups
Snippets