Improve the documentation #8
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
jeanconn
reviewed
Jul 15, 2020
|
|
||
| The standard built-in Time formats that are available in CxoTime are: | ||
| - In `CxoTime` the date '2001-01-01T00:00:00' is UTC by default, while in | ||
| `DateTime` that is interpreted as TT by default. This is triggered by |
There was a problem hiding this comment.
Fine with the doc but I don't remember having a conversation about these defaults.
Is it more confusing that there's a difference between Datetime and CxoTime in this regard (what is in there) or more confusing to have different default time systems depending on the string (what you'd have if you used the DateTime logic)?
There was a problem hiding this comment.
I think the DateTime behavior (different time system depending on there being a T or not) is very confusing for anyone but Arnold and people steeped in FITS. There might be some issue reading FITS times in CXC files, so that is a concern but only if we migrate core cron processing to CxoTime, which is not likely in the near future.
jeanconn
reviewed
Jul 15, 2020
| @@ -53,6 +53,8 @@ The key differences between |CxoTime| and DateTime_ are: | |||
| - Conversely, starting with |CxoTime| one can add or subtract a TimeDelta_ or | |||
| any quantity with time units. | |||
|
|
|||
| - To get the current time replace ``DateTime()`` with ``CxoTime.now()`` | |||
jeanconn
approved these changes
Jul 15, 2020
Merged
Merged
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.
Description
Based on user feedback and re-review by me, the docs needed some improvement.
Testing
Builds with sphinx with no errors and only warnings from the upstream astropy docstring.