Skip to content

Add Documentation on UV and Tool Usage - #42854

Merged
JennyPng merged 11 commits into
Azure:mainfrom
JennyPng:jennypng-check-documentation
Sep 16, 2025
Merged

Add Documentation on UV and Tool Usage#42854
JennyPng merged 11 commits into
Azure:mainfrom
JennyPng:jennypng-check-documentation

Conversation

@JennyPng

@JennyPng JennyPng commented Sep 4, 2025

Copy link
Copy Markdown
Member

Description

#42858

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

@JennyPng JennyPng self-assigned this Sep 8, 2025
Comment thread doc/tool_usage_guide.md Outdated
Comment thread doc/tool_usage_guide.md Outdated
Comment thread doc/tool_usage_guide.md
Comment thread doc/tool_usage_guide.md Outdated
Comment thread doc/tool_usage_guide.md
Comment thread doc/tool_usage_guide.md
Comment thread doc/tool_usage_guide.md
Comment thread doc/tool_usage_guide.md Outdated

@scbedd scbedd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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!

@scbedd

scbedd commented Sep 15, 2025

Copy link
Copy Markdown
Member

Oh and add azpysdk to the dictionary of known words in .vscode/cspell.json.

@JennyPng
JennyPng marked this pull request as ready for review September 15, 2025 19:10
Copilot AI review requested due to automatic review settings September 15, 2025 19:10

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 azpysdk entrypoint 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 azpysdk term

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

Comment thread doc/tool_usage_guide.md Outdated
Comment thread doc/tool_usage_guide.md Outdated
Comment thread doc/tool_usage_guide.md Outdated
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Comment thread .vscode/cspell.json
Co-authored-by: Scott Beddall <45376673+scbedd@users.noreply.github.com>
@JennyPng
JennyPng merged commit 6d067b3 into Azure:main Sep 16, 2025
22 checks passed
@JennyPng
JennyPng deleted the jennypng-check-documentation branch September 16, 2025 17:45
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.

3 participants