Skip to content

[docs] Fix documentation inconsistencies: Python 3.9 minimum and pyproject.toml references#7

Draft
github-actions[bot] wants to merge 4 commits intomainfrom
doc/fix-doc-inconsistencies-python39-pyproject-80c5cb17fdce94b8
Draft

[docs] Fix documentation inconsistencies: Python 3.9 minimum and pyproject.toml references#7
github-actions[bot] wants to merge 4 commits intomainfrom
doc/fix-doc-inconsistencies-python39-pyproject-80c5cb17fdce94b8

Conversation

@github-actions
Copy link
Copy Markdown

@github-actions github-actions Bot commented Apr 6, 2026

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.md

  • Python version: Updated minimum version from 3.8 → 3.9, consistent with azure-core (requires-python = ">=3.9"), the sdk/template package (requires-python = ">=3.9"), and tool_usage_guide.md ("The monorepo requires a minimum of python 3.9").
  • Mandatory files list: Replaced setup.py and setup.cfg (no longer present in the template package) with pyproject.toml, which is what the sdk/template/azure-template package uses.
  • venv example: Updated the example path from Python38 to Python39.

doc/dev/packaging.md

  • Updated "Wheels must work with Python 3.8+" constraint to 3.9+.
  • Updated python_requires=">=3.8" to >=3.9 in the example setup.py snippet (two occurrences).
  • Removed the Python 3.8 classifier from the example setup.py classifiers list.
  • Updated the "updating to Python 3 only" section to say >=3.9.

doc/dev/static_type_checking.md

  • py.typed configuration: Replaced the setup.py-based instruction (include_package_data=True + package_data) with the pyproject.toml-based equivalent ([tool.setuptools.package-data] with pytyped = ["py.typed"]), linking to the template pyproject.toml as a reference. Packages like azure-core and azure-template no longer ship a setup.py.
  • typing-extensions example link: Replaced the stale historical commit SHA link pointing to setup.py#L73 with a link to the current pyproject.toml for azure-eventhub on main. Also removed the outdated mention of "Python 3.7+" backport support (minimum is now 3.9).

doc/eng_sys_checks.md

  • Removed "right next to each package's setup.py" from the pyproject.toml section description — packages now use pyproject.toml only, not alongside setup.py.
  • Updated depends, latestdependency, and mindependency check descriptions: replaced "setup.py" with "pyproject.toml" as the source of package requirements.

doc/tool_usage_guide.md

  • Updated verifysdist description from "correct within the setup.py" to "correct within the package configuration".

Verification

Each change was verified against:

  • sdk/template/azure-template/pyproject.toml — uses requires-python = ">=3.9", has no setup.py
  • sdk/core/azure-core/pyproject.toml — uses requires-python = ">=3.9", [tool.setuptools.package-data] for py.typed
  • doc/tool_usage_guide.md — already states "The monorepo requires a minimum of python 3.9"
  • sdk/eventhub/azure-eventhub/pyproject.toml — contains the typing-extensions>=4.0.1 dependency

Generated by Documentation Consistency Check ·

Warning

⚠️ Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • releaseassets.githubusercontent.com

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "releaseassets.githubusercontent.com"

See Network Configuration for more information.

mccoyp and others added 4 commits March 18, 2026 02:13
- 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>
@github-actions github-actions Bot added automated documentation Improvements or additions to documentation labels Apr 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

automated documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant