Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up time tutorial #6920

Merged
merged 5 commits into from
Apr 28, 2023
Merged

Clean up time tutorial #6920

merged 5 commits into from
Apr 28, 2023

Conversation

dstansby
Copy link
Member

Fixes #6863. Not perfect, but a lot better and good enough for 5.0 I think.

@dstansby dstansby added this to the 5.0.0 milestone Apr 15, 2023
@dstansby dstansby requested a review from a team as a code owner April 15, 2023 20:45
docs/tutorial/time.rst Outdated Show resolved Hide resolved
docs/tutorial/time.rst Outdated Show resolved Hide resolved
@dstansby dstansby added the No Backport A PR that isn't to be backported to any release branch. (To be used as a flag to other maintainers) label Apr 16, 2023
nabobalis
nabobalis previously approved these changes Apr 18, 2023
@nabobalis nabobalis added the Needs Review Needs reviews before merge. label Apr 18, 2023
@nabobalis nabobalis removed the Needs Review Needs reviews before merge. label Apr 23, 2023
@nabobalis

This comment was marked as resolved.

@dstansby dstansby added the Needs Review Needs reviews before merge. label Apr 23, 2023
sunpy/time/time.py Outdated Show resolved Hide resolved
docs/tutorial/time.rst Outdated Show resolved Hide resolved
docs/tutorial/time.rst Outdated Show resolved Hide resolved
docs/tutorial/time.rst Outdated Show resolved Hide resolved
docs/tutorial/time.rst Outdated Show resolved Hide resolved
docs/tutorial/time.rst Outdated Show resolved Hide resolved
Copy link
Member

@wtbarnes wtbarnes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree that this is an improvement over what was here previously, but I think this section of the tutorial could still do with some major restructuring. Currently, it still is in a more how-to format than tutorial. In particular, I think this section could be structured in three sections:

  1. Parsing time
  2. Arithmetic with time
  3. Time ranges

In section 1, we could parse two times (from different formats), perform some (very basic) arithmetic with them in section 2, and then construct a time range from them in section 3.

We are pretty late in the game for 5.0 so if these changes feel like to much for this PR, I'm ok punting this larger rewrite to 5.1.

Copy link
Member

@wtbarnes wtbarnes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll create another issue with my other suggestions. I think this is a big improvement and is a better compliment to our new how-to for parsing time.

docs/tutorial/time.rst Outdated Show resolved Hide resolved
Co-authored-by: Will Barnes <will.t.barnes@gmail.com>
@nabobalis nabobalis merged commit f19ea2d into sunpy:main Apr 28, 2023
@nabobalis nabobalis removed the Needs Review Needs reviews before merge. label Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No Backport A PR that isn't to be backported to any release branch. (To be used as a flag to other maintainers)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve "Times" section of the tutorial
3 participants