Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add docstrings to all functions #188

Open
paddyroddy opened this issue Sep 10, 2024 · 0 comments · May be fixed by #381
Open

Add docstrings to all functions #188

paddyroddy opened this issue Sep 10, 2024 · 0 comments · May be fixed by #381
Assignees
@paddyroddy
Labels
blocked The issue or pull request is blocked by something documentation Improvements or additions to documentation

Comments

@paddyroddy
Copy link
Member

Currently, most have them but those that are lacking do stick out in the documentation - which automatically pulls from them
@paddyroddy paddyroddy added the documentation Improvements or additions to documentation label Sep 10, 2024
@paddyroddy paddyroddy mentioned this issue Oct 9, 2024
Merged
paddyroddy added a commit that referenced this issue Oct 14, 2024
@paddyroddy
gh-346: enforce NumPy docstrings + use static typing in docs (#347)
41c4266 
Closes #346. Working towards #188.

The main changes here have been:
- Remove all types in the docstrings in favour of proper static typing
(being added in #308)
- Switch from `numpydoc` to `sphinx.ext.napolean` due to
numpy/numpydoc#196

Have had to change the references to `[1]` rather than `[1]_` due to
this bug, sphinx-doc/sphinx#9689. Hopefully
this can be fixed in the future.

Example:
`glass.lensing.from_convergence`
<img width="781" alt="image"
src="https://github.com/user-attachments/assets/9b6fd087-686a-4a5c-a77a-f8a3ec9fc3e2">

Raised #350, #351.
@paddyroddy paddyroddy mentioned this issue Oct 17, 2024
Merged
This was referenced Oct 25, 2024
Closed
Closed
paddyroddy added a commit that referenced this issue Oct 25, 2024
@paddyroddy
gh-188: add docstrings to all functions and tidy docs
47bebc0
@paddyroddy paddyroddy linked a pull request Oct 25, 2024 that will close this issue
Open
@paddyroddy paddyroddy linked a pull request Oct 30, 2024 that will close this issue
gh-188: add docstrings to all functions and tidy docs #381
Open
@paddyroddy paddyroddy added the blocked The issue or pull request is blocked by something label Oct 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@paddyroddy paddyroddy

Labels
blocked The issue or pull request is blocked by something documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-188: add docstrings to all functions and tidy docs glass-dev/glass
2 participants
@paddyroddy @Saransh-cpp