Skip to content

[docs] Fix documentation inconsistencies with current tooling#47582

Draft
Copilot wants to merge 2 commits into
mainfrom
copilot/docs-fix-documentation-inconsistencies
Draft

[docs] Fix documentation inconsistencies with current tooling#47582
Copilot wants to merge 2 commits into
mainfrom
copilot/docs-fix-documentation-inconsistencies

Conversation

Copilot AI commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Several doc files contained stale references to setup.py/setup.cfg (superseded by pyproject.toml) and outdated pinned versions for mypy and pyright.

Changes

doc/dev/static_type_checking.md

  • mypy pin: 1.9.01.19.1
  • pyright pin: 1.1.2871.1.407 (3 occurrences)
  • Broken link azure-eventhub/setup.py#L73azure-eventhub/pyproject.toml#L27
  • py.typed registration: replaced include_package_data + package_data in setup.py with [tool.setuptools.package-data] in pyproject.toml

doc/dev/tests.md

  • Removed setup.py and setup.cfg from required SDK root file list; added pyproject.toml

doc/dev/dataplane_generation.md

  • "like setup.py, README.md""like pyproject.toml, README.md"

doc/dev/packaging.md

  • Added top-of-file callout clarifying this doc describes legacy setup.py-based packaging; links to current sdk/template/azure-template

doc/dev/changelog_updates.md

  • Removed "(instead of or alongside setup.py)" — packages use pyproject.toml exclusively

doc/deprecation_process.md

  • Updated metadata file list to cite pyproject.toml classifiers instead of setup.py
  • Merged the duplicate ## setup.pyDevelopment Status classifier step into the existing ## pyproject.toml section

doc/eng_sys_checks.md

  • Dropped "right next to each package's setup.py" from the pyproject.toml section intro
  • 5 occurrences of setup.py (or setup.py/pyproject.toml) updated to reference pyproject.toml only

doc/tool_usage_guide.md

  • verifysdist description: setup.pypyproject.toml

All version numbers verified against eng/tools/azure-sdk-tools/azpysdk/mypy.py and pyright.py; package structure claims verified against sdk/template/azure-template/.

Co-authored-by: JennyPng <63012604+JennyPng@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix documentation inconsistencies with current tooling [docs] Fix documentation inconsistencies with current tooling Jun 19, 2026
Copilot AI requested a review from JennyPng June 19, 2026 21:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs] Fix documentation inconsistencies with current tooling

2 participants