Suggestions for improvements over PR 3307#1
Merged
Conversation
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.
abravalheri
commented
May 6, 2022
| without ``setup.py``. | ||
|
|
||
|
|
||
| .. _keyword/name: |
Author
There was a problem hiding this comment.
The only thing I am unsure here is if the :ref: rule provided by Sphinx supports the / character...
I think it is nice to have this kind of "ad-hoc namespacing" to avoid collisions...
abravalheri
commented
May 6, 2022
1 task
Owner
|
Everything looks great! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Hi Jeremy, thank you very much for the PR.
I am using this opportunity to address other related things (such as issue 2795).
Please let me know what do you think about the following suggestions.
Summary of changes
Avoid mentioning that pip is used for download:
It seems that setuptools currently uses its own mechanism for downloading dependencies (
setuptools/package_index.py).We can simply not mention anything, this way we avoid any potential mistakes.
Add markup to highlight deprecation of test-related keywords
Currently these fields don't have a warning. I think this is a nice improvement.
Fix markup on keywords documentation
As pointed out in issue 2795, currently some fields have inconsistent markup.
Due to extra new lines they are interpreted by the rst parser as quoted blocks.
Add introduction text to keywords docs - requested in 2795.
Add anchors for keywords in docs - requested in 2795.
Make the separation between distutils and setuptools keywords more clear
This is a follow up to the comment in [Docs] exhaustively document setup parameters pypa/setuptools#3254 (comment).
The biggest value of keeping the
userguide/keywordsdocument is to retain information about which keywords have changed.Therefore it makes sense to preserve (and highlight) that information.
Move userguide/keywords to deprecated/changed_keyworkds
This addresses the comment in [Docs] exhaustively document setup parameters pypa/setuptools#3254 (comment).
It is a way of retaining the information for reference, while keeping it away from the main part of the docs to not cause confusion.
Pull Request Checklist
changelog.d/.(See documentation for details)