[docs] Documentation consistency fixes across doc/ folder#4
Draft
github-actions[bot] wants to merge 2 commits intomainfrom
Draft
[docs] Documentation consistency fixes across doc/ folder#4github-actions[bot] wants to merge 2 commits intomainfrom
github-actions[bot] wants to merge 2 commits intomainfrom
Conversation
…ev docs - release.md: replace non-existent build_package.py with 'python -m build' - engineering_assumptions.md: update CI Python version from 3.6 to 3.9 - eng_sys_checks.md: replace non-existent build_packages.py with 'python -m build' - static_type_checking.md: update py.typed setup to mention pyproject.toml approach - tests.md: replace setup.py/setup.cfg with pyproject.toml (matching current template) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- static_type_checking.md: fix incorrect section name [tool.azure-sdk-build] to the correct [tool.setuptools.package-data] for pyproject.toml py.typed config - tests.md: update minimum Python version from 3.8 to 3.9, matching azure-core, azure-template, and tool_usage_guide.md; add Python 3.13 Windows Store link 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 documentation inconsistencies found across the
doc/folder by auditing every markdown file against the current source code and repository structure.Changes Made
1.
doc/dev/release.md— Remove non-existentbuild_package.pyscriptIssue: "To build a package manually" instruction referenced
python .\build_package.py azure-mgmt-myservice, but this script does not exist at the repo root.Fix: Replaced with
python -m build sdk/(service-dir)/azure-mgmt-myservice(using the standardbuildpackage, consistent with modern Python packaging practice). Also fixed the prose — the original sentence was incomplete: "This will a sdist and a wheel file."2.
doc/dev/engineering_assumptions.md— Update CI Python wheel-build versionIssue: States wheels are generated "by a CI step running
Python 3.6." CI has used Python 3.9+ for years; Python 3.6 reached EOL in December 2021.Fix: Changed
Python 3.6→Python 3.9.3.
doc/eng_sys_checks.md— Remove non-existentscripts/devops_tasks/build_packages.pyIssue: "Steps to manually run regression test locally" instruction referenced
./scripts/devops_tasks/build_packages.pywhich does not exist at that path in the repository.Fix: Replaced with
python -m build sdk/(service-name)/(package-name) --outdir (out-folder).4.
doc/dev/static_type_checking.md— Fixpy.typedpyproject.tomlsection nameIssue: Instructed users to add
pytyped = ["py.typed"]under[tool.azure-sdk-build], but the correct section (as verified insdk/core/azure-core/pyproject.tomlandsdk/template/azure-template/pyproject.toml) is[tool.setuptools.package-data].Fix: Corrected section name from
[tool.azure-sdk-build]to[tool.setuptools.package-data].5.
doc/dev/tests.md— Update packaging file list and Python minimum versionIssue (packaging files): Listed
setup.pyandsetup.cfgas the mandatory SDK package files, but the current template (sdk/template/azure-template/) usespyproject.tomlwith nosetup.pyorsetup.cfg.Fix: Replaced both entries with a single
pyproject.tomlentry.Issue (Python version): Stated "Python 3.8+" as the minimum SDK version throughout, but
azure-core,azure-template, andtool_usage_guide.mdall specify>=3.9as the current minimum. The Windows Store version list also omitted Python 3.13 and included the EOL Python 3.8.Fix: Updated all references to reflect Python 3.9+ as the minimum; updated the Windows Store version list accordingly.
Verification
pyproject.tomlforazure-coreandazure-templateconfirm the[tool.setuptools.package-data]section name and>=3.9requirement.tool_usage_guide.mdstates: "The monorepo requires a minimum ofpython 3.9."build_package.pyandscripts/devops_tasks/build_packages.pyconfirmed absent from the repository.Warning
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.