Request-for-comments about adding version annotations #118
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
vstehle
added
help wanted
vstehle
force-pushed
the
rfc-versions
branch
3 times, most recently
from
79c0957 to
6d131e7
Compare
|
Rebased. |
vstehle
force-pushed
the
rfc-versions
branch
2 times, most recently
from
95a628c to
a6b9016
Compare
Add version annotations for new and updated requirements, starting from EBBR v1.0. This is a request-for-comments, to fuel discussions, and is not to be merged. Signed-off-by: Vincent Stehlé <[email protected]>
|
Having the version information at the end of each chapter requires a lot of scrolling. Please, place the information above the referenced element. versionadded makes some sense. But versionchanged does not tell what the change was. Could be a typo fix or a big change. The HTML output uses CSS class "versionmodified". You can use it CSS to have the versionadded information in smaller type and in a different color. See https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html. For PDF output see https://www.sphinx-doc.org/en/master/latex.html. |
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.
In chapter 1 we say that:
We have started to do so in the index history table, but we could also add more explicit annotations nearer to the concerned chapters using specific annotations as shown here.
This is a request-for-comments, to fuel discussions, and is not to be merged.
Please give your feedback in this pull request.