Fix of Issue #680 #1359
Merged
Fix of Issue #680 #1359
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
…multi-line # to be docstrings where appropriate
Codecov Report
@@ Coverage Diff @@
## master #1359 +/- ##
=======================================
Coverage 71.77% 71.77%
=======================================
Files 66 66
Lines 5077 5077
=======================================
Hits 3644 3644
Misses 1433 1433
Continue to review full report at Codecov.
|
Going through and writing documentation guidelines, noticed that the carriage returns at line 450 and 456 were missing somehow, most likely from me missing them. I added those two carriage returns to make them consistent with the rest of the docstrings.
andrewfullard
approved these changes
Nov 30, 2020
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* Inside of tardis/docs/pphysics/plasma/plasma_plots updated two files multi-line # to be docstrings where appropriate * Some more documentation updates * Finished issue tardis-sn#680 * Fixed the last file for tardis-sn#680 * Fixed two random indentation irregularities found upon review * Update base.py * Update base.py * Update packet_source.py Going through and writing documentation guidelines, noticed that the carriage returns at line 450 and 456 were missing somehow, most likely from me missing them. I added those two carriage returns to make them consistent with the rest of the docstrings.
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.
Read through the files in tardis and address all instances of issue #680 that I found.
Description
Issue #680, #680, has to deal with type-hinting in PyCharm. There are certain docstring syntaxs that break type-hinting, such as Paramaters: (Any keyword with a : following). Also, under the keywords, if you define a var: "~" it also breaks type-hinting, so that was removed. All of the keywords are now capitalized with no : following them, and they have the appropriate number of ----- in the line below that matches the keyword's character length. All variables are in the format of "Var : type" with an option description indented by one tab in the following line. There is one carriage return between the last variable and a new keyword in the docstring if applicable. Removed leading and trailing carriage returns from the docstrings as well to match the numpy docstring standard.
Motivation and Context
This is a bugfix and a quality-of-life issue that makes it easier to write the code and interact with it, as you can also see descriptions of each variable when applicable if there is the correct docstring formatting.
How Has This Been Tested?
I have been unable to test this, but I have re-read all of the files in tardis 3 times to make sure I have the right format.
Screenshots (if appropriate):
Types of changes
Checklist: