Add Documentation on UV and Tool Usage - #42854
Merged
Merged
Conversation
JennyPng
commented
Sep 8, 2025
scbedd
reviewed
Sep 8, 2025
scbedd
reviewed
Sep 8, 2025
scbedd
reviewed
Sep 8, 2025
scbedd
reviewed
Sep 8, 2025
scbedd
reviewed
Sep 8, 2025
scbedd
reviewed
Sep 8, 2025
20 tasks
scbedd
reviewed
Sep 15, 2025
scbedd
approved these changes
Sep 15, 2025
scbedd
left a comment
Member
There was a problem hiding this comment.
I've got one last piece of feedback that I'd like you to incorporate...but if you merged this as-is I wouldn't block, so approving!
Member
|
Oh and add |
JennyPng
marked this pull request as ready for review
September 15, 2025 19:10
JennyPng
requested review from
benbp,
laiapat and
weshaggard
as code owners
September 15, 2025 19:10
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR introduces comprehensive documentation for the Azure Python SDK's new tool usage system, specifically focusing on the migration from tox-based checks to the new azpysdk entrypoint. The documentation provides developers with clear guidance on using modern tools like UV for faster package management and development workflows.
Key Changes
- Adds a complete tool usage guide covering the new
azpysdkentrypoint and available tools - Updates CONTRIBUTING.md to include UV as a recommended package manager alongside existing tools
- Adds spell-check dictionary entry for the new
azpysdkterm
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| doc/tool_usage_guide.md | New comprehensive guide covering azpysdk tools, setup procedures, and usage patterns |
| CONTRIBUTING.md | Updated tools overview section to include UV package manager documentation |
| .vscode/cspell.json | Added "azpysdk" to spell-check dictionary to prevent false positives |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
4 tasks
scbedd
reviewed
Sep 16, 2025
scbedd
approved these changes
Sep 16, 2025
Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>
scbedd
approved these changes
Sep 16, 2025
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.
Description
#42858
All SDK Contribution checklist:
General Guidelines and Best Practices
Testing Guidelines