[docs] Fix documentation inconsistencies in doc folder - #48561
Open
Hashim Khan (Hashim1999164) wants to merge 1 commit into
Open
[docs] Fix documentation inconsistencies in doc folder#48561Hashim Khan (Hashim1999164) wants to merge 1 commit into
Hashim Khan (Hashim1999164) wants to merge 1 commit into
Conversation
Correct outdated titles, migrated learn.microsoft.com links, keyvault test-resources references, packaging examples, and deprecated wheel build guidance so contributor docs match the current repo. Fixes Azure#48507.
Hashim Khan (Hashim1999164)
requested review from
a team and
Daniel Jurek (danieljurek)
as code owners
August 12, 2026 23:37
github-actions
Bot
added
Community Contribution
Contributor
|
Thank you for your contribution Hashim Khan (@Hashim1999164)! We will review the pull request and get back to you soon. |
|
Azure Pipelines: Successfully started running 1 pipeline(s). 7 pipeline(s) were filtered out due to trigger conditions. There may be pipelines that require an authorized user to comment /azp run to run. |
Copilot started reviewing on behalf of
Hashim Khan (Hashim1999164)
August 12, 2026 23:39
View session
Contributor
There was a problem hiding this comment.
Pull request overview
Updates contributor documentation to match current repository paths, tooling, packaging, and Microsoft Learn URLs.
Changes:
- Updates obsolete documentation links and Key Vault resource references.
- Modernizes wheel-building and packaging examples.
- Corrects the developer setup title and Python classifiers.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
doc/dev/dev_setup.md |
Corrects the page title. |
doc/dev/docstring.md |
Updates Form Recognizer links. |
doc/dev/mgmt/generation.md |
Modernizes the wheel build command. |
doc/dev/mgmt/tests.md |
Updates Microsoft Learn links. |
doc/dev/packaging.md |
Modernizes packaging examples and classifiers. |
doc/dev/tests.md |
Updates setup and test-resource links. |
doc/request_builders.md |
Migrates reference links to Microsoft Learn. |
doc/send_request.md |
Migrates reference links to Microsoft Learn. |
💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+99
to
+101
| with open('README.md', encoding='utf-8') as f: | ||
| readme = f.read() | ||
| with open('HISTORY.rst', encoding='utf-8') as f: | ||
| with open('CHANGELOG.md', encoding='utf-8') as f: |
| 'Programming Language :: Python :: 3.10', | ||
| 'Programming Language :: Python :: 3.11', | ||
| 'Programming Language :: Python :: 3.12', | ||
| 'Programming Language :: Python :: 3.13', |
| And that's it! You should now have Python code ready to test. Note that this generation is for testing only and should not be sent to a customer or published to PyPI. | ||
|
|
||
| This command generate code only. If you want to generate a [wheel](https://pythonwheels.com/) file to share this code, add the `--basic-setup-py` option to generate a basic `setup.py` file and call `python setup.py bdist_wheel`. | ||
| This command generate code only. If you want to generate a [wheel](https://pythonwheels.com/) file to share this code, add the `--basic-setup-py` option to generate a basic `setup.py` file and call `python -m build --wheel`. |
Comment on lines
+589
to
+590
| [kv_test_resources_outputs]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/test-resources.bicep | ||
| [kv_test_resources_resources]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/keyvault/test-resources.bicep |
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
Updates contributor docs so they match the current repository and public documentation URLs.
Notable fixes:
doc/dev/dev_setup.mdtitle is now Developer Setuptest-resources.biceplinks indoc/dev/tests.mddocs.microsoft.com→learn.microsoft.comin mgmt tests, docstring, request builders, and send_request docspython setup.py bdist_wheel→python -m build --wheelREADME.md/CHANGELOG.mdand adds the Python 3.13 classifierFixes #48507
Test plan
sdk/keyvault/test-resources.bicepon main