You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR fixes documentation inconsistencies found across the doc/ folder by verifying claims against the actual source code and repository structure.
Changes
doc/dev/static_type_checking.md
Outdated mypy version: Updated from 1.9.0 → 1.19.1 (verified against eng/tools/azure-sdk-tools/azpysdk/mypy.py)
Outdated pyright version: Updated from 1.1.287 → 1.1.407 in three places (verified against eng/tools/azure-sdk-tools/azpysdk/pyright.py)
Broken setup.py link: The link to azure-eventhub/setup.py#L73 was broken because that file no longer exists; replaced with a link to azure-eventhub/pyproject.toml
Outdated py.typed setup instructions: Replaced instructions to set include_package_data=True and package_data in setup.py with the current pyproject.toml equivalent ([tool.setuptools.package-data])
doc/dev/tests.md
Stale required file list: Removed setup.py and setup.cfg from the list of required SDK root files; replaced with pyproject.toml (verified: sdk/template/azure-template has no setup.py/setup.cfg, only pyproject.toml)
doc/dev/dataplane_generation.md
Stale reference: Changed "like setup.py, README.md" to "like pyproject.toml, README.md"
doc/dev/packaging.md
Entire doc is setup.py-based: Added a prominent note at the top clarifying this document covers legacy packages only, with a link to the current pyproject.toml-based template
doc/dev/changelog_updates.md
Outdated phrasing: Removed "(instead of or alongside setup.py)" — all packages now use pyproject.toml
doc/deprecation_process.md
setup.py classifiers reference: Updated the list of metadata-only files to reference pyproject.toml instead of setup.py
Duplicate ## setup.py section: Merged the Development Status classifier update instruction into the existing ## pyproject.toml section (classifiers live in pyproject.toml now)
doc/eng_sys_checks.md
"right next to each package's setup.py": Removed the outdated setup.py co-location note
setup.py/pyproject.toml references: Updated 5 occurrences to reference only pyproject.toml
doc/tool_usage_guide.md
verifysdist description: Updated to reference pyproject.toml instead of setup.py for py.typed configuration
Verification
All version numbers were verified against the actual CI tooling:
MYPY_VERSION = "1.19.1" in eng/tools/azure-sdk-tools/azpysdk/mypy.py
PYRIGHT_VERSION = "1.1.407" in eng/tools/azure-sdk-tools/azpysdk/pyright.py
Package structure claims were verified against sdk/template/azure-template/ and sdk/core/azure-core/ — neither has setup.py or setup.cfg, both use only pyproject.toml.
The bundle file is available in the agent artifact in the workflow run linked above.
To create a pull request with the changes:
# Download the artifact from the workflow run
gh run download 27844043482 -n agent -D /tmp/agent-27844043482
# Fetch the bundle into a temporary ref, then update the local branch
git fetch /tmp/agent-27844043482/aw-doc-fix-documentation-inconsistencies.bundle refs/heads/doc/fix-documentation-inconsistencies:refs/bundles/create-pr-doc-fix-documentation-inconsistencies-24ac64bb8cb27677-e97ea066
git update-ref refs/heads/doc/fix-documentation-inconsistencies-24ac64bb8cb27677 refs/bundles/create-pr-doc-fix-documentation-inconsistencies-24ac64bb8cb27677-e97ea066
git checkout doc/fix-documentation-inconsistencies-24ac64bb8cb27677
# Ensure the working tree matches the updated branch
git reset --hard
# Remove the temporary bundle ref
git update-ref -d refs/bundles/create-pr-doc-fix-documentation-inconsistencies-24ac64bb8cb27677-e97ea066
# Push the branch to origin
git push origin doc/fix-documentation-inconsistencies-24ac64bb8cb27677
# Create the pull request
gh pr create --title '[docs] Fix documentation inconsistencies with current tooling' --base main --head doc/fix-documentation-inconsistencies-24ac64bb8cb27677 --repo Azure/azure-sdk-for-python
Caution
Protected files were modified in this change.
This pull request is in
request_reviewmode and requires explicit human scrutiny before merge.Protected files:
.github/aw/actions-lock.json,.github/workflows/agentics-maintenance.yml,.github/workflows/doc-consistency-check.lock.ymlSummary
This PR fixes documentation inconsistencies found across the
doc/folder by verifying claims against the actual source code and repository structure.Changes
doc/dev/static_type_checking.md1.9.0→1.19.1(verified againsteng/tools/azure-sdk-tools/azpysdk/mypy.py)1.1.287→1.1.407in three places (verified againsteng/tools/azure-sdk-tools/azpysdk/pyright.py)setup.pylink: The link toazure-eventhub/setup.py#L73was broken because that file no longer exists; replaced with a link toazure-eventhub/pyproject.tomlpy.typedsetup instructions: Replaced instructions to setinclude_package_data=Trueandpackage_datainsetup.pywith the currentpyproject.tomlequivalent ([tool.setuptools.package-data])doc/dev/tests.mdsetup.pyandsetup.cfgfrom the list of required SDK root files; replaced withpyproject.toml(verified:sdk/template/azure-templatehas nosetup.py/setup.cfg, onlypyproject.toml)doc/dev/dataplane_generation.mdsetup.py, README.md" to "likepyproject.toml, README.md"doc/dev/packaging.mdpyproject.toml-based templatedoc/dev/changelog_updates.mdsetup.py)" — all packages now usepyproject.tomldoc/deprecation_process.mdsetup.pyclassifiers reference: Updated the list of metadata-only files to referencepyproject.tomlinstead ofsetup.py## setup.pysection: Merged theDevelopment Statusclassifier update instruction into the existing## pyproject.tomlsection (classifiers live inpyproject.tomlnow)doc/eng_sys_checks.mdsetup.py": Removed the outdatedsetup.pyco-location notesetup.py/pyproject.tomlreferences: Updated 5 occurrences to reference onlypyproject.tomldoc/tool_usage_guide.mdverifysdistdescription: Updated to referencepyproject.tomlinstead ofsetup.pyfor py.typed configurationVerification
All version numbers were verified against the actual CI tooling:
MYPY_VERSION = "1.19.1"ineng/tools/azure-sdk-tools/azpysdk/mypy.pyPYRIGHT_VERSION = "1.1.407"ineng/tools/azure-sdk-tools/azpysdk/pyright.pyPackage structure claims were verified against
sdk/template/azure-template/andsdk/core/azure-core/— neither hassetup.pyorsetup.cfg, both use onlypyproject.toml.Note
This was originally intended as a pull request, but the git push operation failed.
Workflow Run: View run details and download bundle artifact
The bundle file is available in the
agentartifact in the workflow run linked above.To create a pull request with the changes: