Converted dateTimeContinuted.py to numpydoc status #60
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
ktlim
reviewed
Jun 19, 2020
| @param timescale Timescale for resultant datetime | ||
| Parameters | ||
| ---------- | ||
| timescale : `dateTime.DateTime.Timescale` |
There was a problem hiding this comment.
Suggested change
| timescale : `dateTime.DateTime.Timescale` | |
| timescale : `dateTime.DateTime.Timescale`, optional |
| @@ -49,3 +57,4 @@ def __repr__(self): | |||
|
|
|||
| def __reduce__(self): | |||
| return (DateTime, (self.nsecs(), )) | |||
|
|
|||
There was a problem hiding this comment.
This blank line is causing the flake8 failure.
|
The commit message could be improved a bit. Aside from the typo, we recommend that it be imperative rather than past tense: https://developer.lsst.io/work/flow.html#writing-commit-summary-lines |
squisty
force-pushed
the
tickets/DM-15815
branch
2 times, most recently
from
37839b9
to
2fe3899
Compare
jdswinbank
reviewed
Jun 26, 2020
There was a problem hiding this comment.
These changes look great — a few minor suggestions in the comments.
However, we still have to set daf_base up to actually build with the Sphinx/numpydoc system. At the moment, I just get:
$ package-docs clean && package-docs build
Traceback (most recent call last):
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/bin/package-docs", line 8, in <module>
sys.exit(main())
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/click/core.py", line 764, in __call__
return self.main(*args, **kwargs)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/click/core.py", line 717, in main
rv = self.invoke(ctx)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/click/core.py", line 1134, in invoke
Command.invoke(self, ctx)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/click/core.py", line 956, in invoke
return ctx.invoke(self.callback, **ctx.params)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/click/core.py", line 555, in invoke
return callback(*args, **kwargs)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/click/decorators.py", line 17, in new_func
return f(get_current_context(), *args, **kwargs)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/documenteer/stackdocs/packagecli.py", line 63, in main
root_dir = discover_package_doc_dir(root_dir)
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/documenteer/stackdocs/rootdiscovery.py", line 46, in discover_package_doc_dir
return str(_search_parents(initial_dir))
File "/opt/lsst/software/stack/conda/miniconda3-py37_4.8.2/envs/lsst-scipipe-1a1d771/lib/python3.7/site-packages/documenteer/stackdocs/rootdiscovery.py", line 118, in _search_parents
raise FileNotFoundError(msg)
FileNotFoundError: Cannot detect a conf.py Sphinx configuration file from /mnt/lsst/src/lsst/daf_base/doc. Are you inside a Sphinx documenation repository?
That means following the instructions at https://developer.lsst.io/stack/layout-of-doc-directory.html — we can talk about this later.
| Parameters | ||
| ---------- | ||
| container : `lsst.daf.base.PropertySet` or `lsst.daf.base.PropertyList` | ||
| Container from which to get the value |
There was a problem hiding this comment.
Maybe “Container including the element”?
| container : `lsst.daf.base.PropertySet` or `lsst.daf.base.PropertyList` | ||
| Container from which to get the value | ||
| name : `str` | ||
| Name of item |
There was a problem hiding this comment.
“Name of element”?
Just to keep the terminology consistent through the dosctring.
| Returns | ||
| ------- | ||
| datetime : `datetime.datetime` | ||
| A converted python datetime object. |
There was a problem hiding this comment.
Suggested change
| A converted python datetime object. | |
| The resultant Python `datetime.datetime` object. |
| Returns | ||
| ------- | ||
| useType : `str` or none | ||
| Use type for the given input. Returns none if input |
There was a problem hiding this comment.
Suggested change
| Use type for the given input. Returns none if input | |
| Type to use for the supplied value. `None` if the input is `bool` or a non-integral value. |
|
There seems to be a bad merge commit on this branch that should be cleaned up with a simple rebase. |
squisty
force-pushed
the
tickets/DM-15815
branch
from
219ac67
to
020698d
Compare
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.
No description provided.