Docs whatsnew enumerated lists #3970
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
tkknight
reviewed
Jan 29, 2021
There was a problem hiding this comment.
The changes look good @bjlittle .
I would suggest also changing the whatsnew guide too though such as the reference to bullet points and the example needs to change to an enumerated list (hash).
- https://github.com/SciTools/iris/blame/master/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst#L62 (there a few references to bullet points)
- https://github.com/SciTools/iris/blame/master/docs/iris/src/developers_guide/documenting/whats_new_contributions.rst#L86. change to a hash instead of a splat.
tkknight
approved these changes
Jan 31, 2021
|
@tkknight Awesome, thanks 👍 |
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 1, 2021
* master: remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958)
tkknight
added a commit
to tkknight/iris
that referenced
this pull request
Feb 9, 2021
* master: (23 commits) Added text to state the Python version used to build the docs. (SciTools#3989) add nox session conda list (SciTools#3990) Add abstract cube summary (SciTools#3987) automate docs discovery of iris and python versions (SciTools#3981) corrected syntax (SciTools#3980) core dev whatsnew entry (SciTools#3978) moved docs dir and updated references to it (SciTools#3975) Fix test_incompatible_dimensions test (SciTools#3977) remove explicit URLs for core dev names from latest.rst (SciTools#3973) document that iris.coords.Coord is an ABC (SciTools#3971) reorganise docs common links + add core devs (SciTools#3972) Docs whatsnew add dropdowns to the template (SciTools#3969) Docs whatsnew enumerated lists (SciTools#3970) Merge back v3p0p1 (SciTools#3966) Captilise installation heading - align SciTools#3958 content with SciTools#3940. (SciTools#3963) Merge back v3p0p0 (SciTools#3960) Extended the installation description (SciTools#3958) Put cube data on the x axis if plotting just a cube against a vertical or y coordinate (SciTools#3906) remove stock_mdi_arrays.npz (SciTools#3913) Gallery: update seasonal ensemble example (SciTools#3933) ...
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.
🚀 Pull Request
Description
This PR changes the default use of bullet points in the documentation whatsnew (excluding the
Highlightsdropdown) for enumerated lists.This helps to easily quantify the number of entries per section, but more importantly it provides a more precise way to reference entries e.g., when referencing a whatsnew entry with users in a written discussion, instead of:
we now have something like:
Also, it's easier to find a numbered entry rather than forcing users to count bullet points... you kinda get the gist 😉
These changes have been applied to the
latest.rst,latest.rst.template,3.0.1.rstand3.0.rst. For convenience, see the rendered results:latest.rst.templateis not built to htmlConsult Iris pull request check list