[docs] Fix documentation inconsistencies: Python 3.9 minimum and pyproject.toml references#7
Draft
github-actions[bot] wants to merge 4 commits intomainfrom
Conversation
- tests.md: update minimum Python version from 3.8 to 3.9, consistent with azure-core and template pyproject.toml (requires-python = '>=3.9') and tool_usage_guide.md; replace setup.py/setup.cfg with pyproject.toml in the mandatory files list; update venv example path from Python38 to Python39 - packaging.md: update Python 3.8+ constraint to 3.9+ throughout, including classifiers in the example setup.py - static_type_checking.md: replace setup.py-based py.typed instruction with pyproject.toml [tool.setuptools.package-data] equivalent; update typing-extensions example link from historical setup.py commit to current pyproject.toml on main branch; remove stale Python 3.7+ backport note since minimum is now 3.9 - eng_sys_checks.md: remove 'right next to each package's setup.py' language (packages now use pyproject.toml only); update depends/ latestdependency/mindependency descriptions to reference pyproject.toml instead of setup.py for package requirements - tool_usage_guide.md: update verifysdist description to reference 'package configuration' instead of 'setup.py' Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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
This PR fixes a set of documentation inconsistencies found across the
doc/folder by verifying each claim against the current source code and repository structure.Changes
doc/dev/tests.mdazure-core(requires-python = ">=3.9"), thesdk/templatepackage (requires-python = ">=3.9"), andtool_usage_guide.md("The monorepo requires a minimum ofpython 3.9").setup.pyandsetup.cfg(no longer present in the template package) withpyproject.toml, which is what thesdk/template/azure-templatepackage uses.Python38toPython39.doc/dev/packaging.md"Wheels must work with Python 3.8+"constraint to 3.9+.python_requires=">=3.8"to>=3.9in the examplesetup.pysnippet (two occurrences).setup.pyclassifiers list.>=3.9.doc/dev/static_type_checking.mdsetup.py-based instruction (include_package_data=True+package_data) with thepyproject.toml-based equivalent ([tool.setuptools.package-data]withpytyped = ["py.typed"]), linking to the templatepyproject.tomlas a reference. Packages likeazure-coreandazure-templateno longer ship asetup.py.setup.py#L73with a link to the currentpyproject.tomlforazure-eventhubon main. Also removed the outdated mention of "Python 3.7+" backport support (minimum is now 3.9).doc/eng_sys_checks.mdsetup.py" from thepyproject.tomlsection description — packages now usepyproject.tomlonly, not alongsidesetup.py.depends,latestdependency, andmindependencycheck descriptions: replaced "setup.py" with "pyproject.toml" as the source of package requirements.doc/tool_usage_guide.mdverifysdistdescription from "correct within the setup.py" to "correct within the package configuration".Verification
Each change was verified against:
sdk/template/azure-template/pyproject.toml— usesrequires-python = ">=3.9", has nosetup.pysdk/core/azure-core/pyproject.toml— usesrequires-python = ">=3.9",[tool.setuptools.package-data]forpy.typeddoc/tool_usage_guide.md— already states "The monorepo requires a minimum ofpython 3.9"sdk/eventhub/azure-eventhub/pyproject.toml— contains thetyping-extensions>=4.0.1dependencyWarning
The following domain was blocked by the firewall during workflow execution:
releaseassets.githubusercontent.comTo allow these domains, add them to the
network.allowedlist in your workflow frontmatter:See Network Configuration for more information.