Combine keyword documentation #3307
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
It seems that setuptools currently uses its own mechanism for downloading dependencies (setuptools/package_index.py).
Due to extra new lines some entries were interpreted by the rst parser as quoted blocks. This change fixes that.
This way we can reference them.
The biggest value of retaining the `userguide/keywords` document is to retain information about which keywords have changed. Therefore it makes sense to preserve (and highlight) that information.
Suggestions for improvements over PR 3307
|
Thank you very much for the updates Jeremy! ❤️ 💚 |
abravalheri
approved these changes
May 9, 2022
|
It is been a while this documentation update has been proposed, so I think we can merge it now. If any member of the community, thinks about a better way of organising it, a follow up PR can be used :) Thank you very much @ucodery! |
1 task
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.
Summary of changes
Merge differing descriptions in references/keywords and userguide/keywords and then link the userguide to references.
Closes #3254
Closes #2795
Pull Request Checklist
changelog.d/].