Fixes numpydoc for util #969
Merged
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
wkerzendorf
reviewed
Oct 17, 2019
tardis/util/base.py
Outdated
| @@ -72,6 +72,20 @@ def __str__(self): | |||
| )) | |||
|
|
|||
| def int_to_roman(i): | |||
| """ | |||
| Convert an integer i into its roman numeral representation. | |||
There was a problem hiding this comment.
probably leave out the i - because that parameter is already described below.
wkerzendorf
reviewed
Oct 17, 2019
tardis/util/base.py
Outdated
| ------- | ||
| : str | ||
| Returns roman numeral representation of i in str format. | ||
|
|
There was a problem hiding this comment.
is this newline standard for numpydoc
|
@kowal180 the tests are failing on github. Do they run locally? The last merge into the master branch passed the test, so I'm not sure what the problem is. |
wkerzendorf
reviewed
Oct 24, 2019
| @@ -307,6 +439,17 @@ def quantity_linspace(start, stop, num, **kwargs): | |||
|
|
|||
|
|
|||
| def convert_abundances_format(fname, delimiter='\s+'): | |||
| """ | |||
There was a problem hiding this comment.
lookup docstring indentation
wkerzendorf
reviewed
Oct 24, 2019
| @@ -253,6 +354,20 @@ def parse_quantity(quantity_string): | |||
|
|
|||
|
|
|||
| def element_symbol2atomic_number(element_string): | |||
| """ | |||
| Takes an element symbol and returns its corresponding atomic number | |||
| Parameters | |||
|
moved to top |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
| wavelength_unit: float, optional(default = u.angstrom) | ||
| Dictates units used for calculating wavelength. | ||
| flux_column: int, optional(default = 1) | ||
| #UNSURE |
There was a problem hiding this comment.
Suggested change
| #UNSURE | |
| column index in which the flux is stored |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
| Parameters | ||
| ---------- | ||
| nu: int | ||
| Frequency of a wave of light |
There was a problem hiding this comment.
Suggested change
| Frequency of a wave of light | |
| Frequency of light |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
|
|
||
| .. math:: | ||
| I(\\nu, T) = \\frac{2h\\nu^3}{c^2}\frac{1}{e^{h\\nu \\beta_\\textrm{rad}} - 1} | ||
|
|
||
| Parameters | ||
| ---------- | ||
| nu: int |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
| ---------- | ||
| nu: int | ||
| Frequency of a wave of light | ||
| T: int |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
| Parameters | ||
| ---------- | ||
| species_string: str | ||
| String containing element symbol and number of electrons missing |
There was a problem hiding this comment.
Suggested change
| String containing element symbol and number of electrons missing | |
| String containing species symbol (e.g. Si II, Fe III) |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
| String containing element symbol and number of electrons missing | ||
|
|
||
| Returns | ||
| ---------- |
There was a problem hiding this comment.
make the minuses just as long as the Returns or Raises
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| :str |
wkerzendorf
reviewed
Oct 29, 2019
tardis/util/base.py
Outdated
|
|
||
| Returns | ||
| ------- | ||
| :int |
wkerzendorf
approved these changes
Nov 5, 2019
tardis/util/base.py
Outdated
| Parameters | ||
| ---------- | ||
| radial1d_mdl | ||
| fname |
There was a problem hiding this comment.
file name for the synpp yaml
tardis/util/base.py
Outdated
| nu: int | ||
| Frequency of a wave of light | ||
| T: int | ||
| nu: flot |
| @@ -121,6 +162,16 @@ def calculate_luminosity(spec_fname, distance, wavelength_column=0, wavelength_u | |||
|
|
|||
|
|
|||
| def create_synpp_yaml(radial1d_mdl, fname, shell_no=0, lines_db=None): | |||
| """ | |||
| #UNSURE | |||
| Parameters | |||
There was a problem hiding this comment.
create a yaml file that is readable from syn++
atharva-2001
pushed a commit
to atharva-2001/tardis
that referenced
this pull request
Oct 1, 2021
* Fixes numpydoc for until.py * Address comments by @wkerzendorf * Continued working on numpydoc_fix * Continuation of work on numpydoc_fix * Adressing fixes proposed by @wkerzendorf * Small fixes to numpydoc format of base.py
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.
In the process of fixing all the numpydoc problems in the util package. This is in relation to #680.
int_to_roman
roman_to_int
calculate_luminosity
create_synpp_yaml
intensity_black_body
species_tuple_to_string
species_string_to_tuple
parse_quantity
element_symbol2atomic_number
atomic_number2element_symbol
reformat_element_symbol
quantity_linspace
convert_abundances_format