Fix incorrect docstrings #1369
Merged
Fix incorrect docstrings #1369
Conversation
This file contains 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
Codecov Report
@@ Coverage Diff @@
## master #1369 +/- ##
=======================================
Coverage 72.38% 72.38%
=======================================
Files 66 66
Lines 5098 5098
=======================================
Hits 3690 3690
Misses 1408 1408
Continue to review full report at Codecov.
|
|
I do not know how to link this Issue: #1154 |
andrewfullard
approved these changes
Dec 7, 2020
jaladh-singhal
requested changes
Dec 8, 2020
There was a problem hiding this comment.
@KevinCawley Nice work to investigate all of this! I've suggested few changes.
Co-authored-by: Jaladh Singhal <[email protected]>
Co-authored-by: Jaladh Singhal <[email protected]>
Fixed the formatting in regards to @jalahdh-singhal 's comments
wkerzendorf
reviewed
Dec 14, 2020
wkerzendorf
reviewed
Dec 14, 2020
wkerzendorf
reviewed
Dec 14, 2020
wkerzendorf
reviewed
Dec 14, 2020
wkerzendorf
reviewed
Dec 14, 2020
Changed the numba.array to numba.ndarray
Changed the r_packet type from RPacket to tardis.montecarlo.montecarlo_numba.r_packet.RPacket
Changed the Pandas DataFrame to pandas.DataFrame, and Numpy Array to numpy.ndarray. Made sure that the indentation was consistent as well.
Changed to Pandas DataFrame/Series/MultiIndex to be pandas.DataFrame/Series/MultiIndex. Also changed the numpy descriptor to numpy.ndarray, and for now moved the type as a comment.
jaladh-singhal
requested changes
Dec 14, 2020
jaladh-singhal
requested changes
Dec 14, 2020
Returns were mostly in : descriptor. Changed them to just be what type, which they are pandas.DataFrame as seen from the inheritance of the class IsotopeAbundances.
Removed trailing carriage returns on docstrings
Naming the variables by their full extensions, not just the class that they are.
Added the whole path (.NumbaPlasma) to the end of the description so the entire path is present.
Made the complete path for variables
Updated the descriptions to try and match comments. Fixed the descriptors for the numpy.ndarrays to make them in the same line.
Fixing the format of docstrings so that the dtype would be same line as the var : type
There was a problem hiding this comment.
Impressive work @KevinCawley - very minor changes and then we're good to go 🎉
Co-authored-by: Jaladh Singhal <[email protected]>
Co-authored-by: Jaladh Singhal <[email protected]>
Co-authored-by: Jaladh Singhal <[email protected]>
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* Fixed to the montecarlo_numba file to compy w/ issue tardis-sn#680 * Fixed the latex equation * Trying to fix merge conflict * revert to conf.py * Remove extra carriage return * Update tardis/io/decay.py Co-authored-by: Jaladh Singhal <[email protected]> * Update decay.py * Update interaction.py * Update tardis/plasma/properties/atomic.py Co-authored-by: Jaladh Singhal <[email protected]> * Update single_packet_loop.py * Update atomic.py Fixed the formatting in regards to @jalahdh-singhal 's comments * Update numba_interface.py Changed the numba.array to numba.ndarray * Update r_packet.py Changed the r_packet type from RPacket to tardis.montecarlo.montecarlo_numba.r_packet.RPacket * Update ion_population.py Changed the Pandas DataFrame to pandas.DataFrame, and Numpy Array to numpy.ndarray. Made sure that the indentation was consistent as well. * Update atomic.py Changed to Pandas DataFrame/Series/MultiIndex to be pandas.DataFrame/Series/MultiIndex. Also changed the numpy descriptor to numpy.ndarray, and for now moved the type as a comment. * fixing merge conflicts * Changed the returns to fit what type they are Returns were mostly in : descriptor. Changed them to just be what type, which they are pandas.DataFrame as seen from the inheritance of the class IsotopeAbundances. * Modification to docstrings and addressing comments * Update base.py Removed trailing carriage returns on docstrings * Update interaction.py Naming the variables by their full extensions, not just the class that they are. * Update macro_atom.py Added the whole path (.NumbaPlasma) to the end of the description so the entire path is present. * Update r_packet.py Made the complete path for variables * Update atomic.py Updated the descriptions to try and match comments. Fixed the descriptors for the numpy.ndarrays to make them in the same line. * Update ion_population.py Fixing the format of docstrings so that the dtype would be same line as the var : type * Update docs/index.rst Co-authored-by: Jaladh Singhal <[email protected]> * Update tardis/plasma/properties/atomic.py Co-authored-by: Jaladh Singhal <[email protected]> * Update tardis/io/decay.py Co-authored-by: Jaladh Singhal <[email protected]> * Update decay.py * Update r_packet.py Co-authored-by: Jaladh Singhal <[email protected]>
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.
Changes were made to .py files to properly display in the TARDIS API.
Description
There were several instances where the formatting of docstrings was incorrect that was causing a breakage in the API. There were also a few LaTeX equations that were not properly formatted, so that was also updated as well. Another formatting error was fixed where it was inconsistent in the lines due to the docstring, which was resolved by donig \n at the start to get uniform documentation and keep with the current format. In addition, there was a small update to the montecarlo/montecarlo_numba folder as some formatting was missed that needed to be fixed.
There is an issue with a YAML creating a text-wall, that will result in a new issue.
Motivation and Context
Quality of Life, as well as making the API consistent and easily readable. Fixes #1154
How Has This Been Tested?
Docs were compiled locally by adding a line before line 80 in tardis/docs/conf.py (nbsphinx_allow_errors = True), and then running "python setup.py build_docs". This change in tardis/docs/conf.py was reverted rigth before this PR.
Screenshots (if appropriate):
Types of changes
Checklist: