Update userguide on miscellaneous and extension
#3367
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
This is a continuation of the update effort to de-emphasize `distutils`
and make the documentation more consistent.
The main targets of the changes are the files
`docs/userguide/miscellaneous` and `docs/userguide/extension`.
Changes:
- Extracted text about automatic resource extraction and the zip-safe flag
from `userguide/miscellaneous` to `deprecated/resource_extraction` and
`deprecated/zip_safe`.
- These configuration parameters are commonly associated with
``eggs``/``easy_install``/``pkg_resources``, and therefore are
obsolete. Leaving them around in the main parts of the documentation
just confuses users.
- The text in the new files were updated.
- Extracted text about additional metadata from
`userguide/miscellaneous` into the existing `userguide/extension`
document.
- Updated `userguide/extension` to better reflect the status of the
setuptools project.
The text was also changed to explain a little bit more what is the
relationship between ``setuptools`` and ``distutils``.
- Removed `userguide/functionalities_rewrite`.
This file was virtually empty and not bringing any extra value to the
docs.
abravalheri
commented
Jun 13, 2022
abravalheri
force-pushed
the
moving-deprecated
branch
from
1909e42
to
2e36857
Compare
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.
This is a continuation of the update effort to de-emphasize
distutilsand make the documentation more consistent.
The main targets of the changes are the files
docs/userguide/miscellaneousanddocs/userguide/extension.Summary of changes
userguide/miscellaneoustodeprecated/resource_extractionanddeprecated/zip_safe.eggs/easy_install/pkg_resources, and therefore are obsolete. Leaving them around in the main parts of the documentation just confuses users.userguide/miscellaneousinto the existinguserguide/extensiondocument.userguide/extensionto better reflect the status of the setuptools project.The text was also changed to explain a little bit more what is the relationship between
setuptoolsanddistutils.userguide/functionalities_rewrite.This file was virtually empty and not bringing any extra value to the docs.
Pull Request Checklist
changelog.d/.(See documentation for details)