Minor improvements to sphinx docs #1248
Merged
Conversation
This file contains hidden or 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
cwhanse
approved these changes
Jun 14, 2021
wholmgren
reviewed
Jun 21, 2021
| @@ -89,7 +89,6 @@ calculations. | |||
| solarposition.equation_of_time_spencer71 | |||
| solarposition.equation_of_time_pvcdrom | |||
| solarposition.hour_angle | |||
| solarposition.sun_rise_set_transit_geometric | |||
There was a problem hiding this comment.
what's the motivation for removing this function here? Seems to me that it fits the section description.
There was a problem hiding this comment.
It's also listed in another section (Functions for calculating sunrise, sunset and transit times) and, to split hairs, it calculates times rather than positions. Happy to put it back if you prefer, I don't feel strongly either way.
wholmgren
approved these changes
Jun 21, 2021
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.
Closes #xxxxTests addedUpdates entries todocs/sphinx/source/api.rstfor API changes.Adds description and name entries in the appropriate "what's new" file indocs/sphinx/source/whatsnewfor all changes. Includes link to the GitHub Issue with:issue:`num`or this Pull Request with:pull:`num`. Includes contributor name and/or GitHub username (link with:ghuser:`user`).New code is fully documented. Includes numpydoc compliant docstrings, examples, and comments where necessary.Assorted minor docs fixes I've been collecting.