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

Nabil's doc review for 5.0 #7032

Merged
merged 10 commits into from
Jun 7, 2023
Merged

Nabil's doc review for 5.0 #7032

merged 10 commits into from
Jun 7, 2023

Conversation

nabobalis
Copy link
Contributor

@nabobalis nabobalis commented May 25, 2023

I focused the commits based on areas of the docs I changed.

Hopefully more manageable to review.

@nabobalis
Copy link
Contributor Author

Failed online test:

FAILED ../../.tox/py39-online/lib/python3.9/site-packages/sunpy/database/tests/test_tables.py::test_entry_from_query_results_with_none_wave_and_default_unit

docs/how_to/create_custom_map.rst Outdated Show resolved Hide resolved
docs/topic_guide/coordinates/rotatedsunframe.rst Outdated Show resolved Hide resolved
docs/topic_guide/coordinates/rotatedsunframe.rst Outdated Show resolved Hide resolved
docs/topic_guide/coordinates/rotatedsunframe.rst Outdated Show resolved Hide resolved
docs/tutorial/acquiring_data/jsoc.rst Outdated Show resolved Hide resolved
docs/tutorial/acquiring_data/jsoc.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.

Very minor suggestions. Thanks for this massive undertaking.

docs/how_to/parse_time.rst Outdated Show resolved Hide resolved
docs/how_to/parse_time.rst Outdated Show resolved Hide resolved
:link-type: ref
:text-align: center

:material-outlined:`accessibility_new;8em;sd-text-secondary`

**New users start here!** Walkthrough on how to install sunpy and use the key features of the package.
**New users start here!**
Walkthrough on how to install sunpy and use the key features of the package.
Copy link
Member

Choose a reason for hiding this comment

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

Does this render nicely in the button?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Looks ok to me:

Screenshot_20230607_132647

docs/topic_guide/installation.rst Outdated Show resolved Hide resolved
docs/topic_guide/logger.rst Outdated Show resolved Hide resolved
docs/tutorial/index.rst Outdated Show resolved Hide resolved
docs/tutorial/maps.rst Outdated Show resolved Hide resolved
docs/tutorial/maps.rst Outdated Show resolved Hide resolved
docs/tutorial/timeseries.rst Outdated Show resolved Hide resolved
docs/tutorial/timeseries.rst Outdated Show resolved Hide resolved
@nabobalis nabobalis merged commit dd54d74 into sunpy:main Jun 7, 2023
@nabobalis nabobalis deleted the doc_review branch June 7, 2023 21:39
meeseeksmachine pushed a commit to meeseeksmachine/sunpy that referenced this pull request Jun 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
No Changelog Entry Needed Skip any changelog checks.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants