Doc strings reformatting #762
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Reformat doc strings so that they match the required format for the LINCC Framesworks incubator template setup for our documentation sphinx setup (which follows the numpy standard https://numpydoc.readthedocs.io/en/latest/format.html)
mschwamb
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #762 +/- ##
==========================================
+ Coverage 74.67% 74.69% +0.01%
==========================================
Files 66 66
Lines 3029 3031 +2
==========================================
+ Hits 2262 2264 +2
Misses 767 767 ☔ View full report in Codecov by Sentry. |
update more doc strings to be in compliance with the format
finish adjustments to doc strings in PPVignetting.py
updating remaining file docstrings to try and get them to be as standarized as possible and generate in readthedocs
black ObjectDataReaderpy
update readme with standard for docstrings
|
All docstrings are standardized as close as I can get them and follow the NumPy format so they now render in read the docs. |
had updated name in the utility to move away from SPP name.
fix change to default table name
| A dictionary with pixel indices as keys and lists of ObjIDs for | ||
| those objects in each HEALPix tile as values. One of these | ||
| calculations is called a 'picket', as one element of a long picket | ||
| fence. At present, |
There was a problem hiding this comment.
There's an unfinished sentence here.
There was a problem hiding this comment.
It was in there to begin with. So I think let's leave it and let it get addressed in #763
astronomerritt
approved these changes
Jan 9, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reformat doc strings so that they match the required format for the LINCC Framesworks incubator template setup for our documentation sphinx setup (which follows the numpy standard https://numpydoc.readthedocs.io/en/latest/format.html)
Fixes #142