Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

[docs] Fix documentation inconsistencies in dev guides

Đang mở
  • Có gì không ổn?
#48,600 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Rà soát doc/dev/tests.md, doc/dev/mgmt/generation.md, doc/dev/packaging.md và doc/dev/static_type_checking.md so với mã nguồn hiện tại và các quy ước của repository được mô tả trong issue. Xác minh các thay đổi được liệt kê đối với hướng dẫn về phiên bản, build, packaging, đánh số và Python 2, sau đó xác nhận rằng cả bốn tài liệu đều không còn điểm không nhất quán nào.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

agentic-workflows automated documentation

This PR fixes several documentation inconsistencies found across doc/dev/ by comparing the docs against current source code and repository conventions.

Changes

doc/dev/tests.md
  • Fixed numbered list (2 occurrences): The list of supported auth tools (AZURE_TEST_USE_*_AUTH) skipped from item 2. directly to 4., omitting 3.. Changed 4. Azure Developer CLI → 3. Azure Developer CLI in both locations (lines ~178 and ~216).
  • Updated Python version example: The virtual environment creation example referenced Python 3.14, which is an unreleased development version. Updated to Python 3.13 (the current stable release).
doc/dev/mgmt/generation.md
  • Removed unnecessary pip install setuptools step: The "Installing Necessary Dependencies" section instructed users to run pip install setuptools after dev_setup.py. This is not needed for modern packages using pyproject.toml and is not documented elsewhere as a requirement.
  • Replaced deprecated build command: python setup.py bdist_wheel is deprecated (PEP 517). Updated to python -m build.
doc/dev/packaging.md
  • Updated legacy setup.py example: The example code read from version.py (without underscore) and README.rst. Current packages use _version.py (with leading underscore) and README.md. Updated the code snippet accordingly.
  • Marked Python 2 / azure-nspkg section as obsolete: The "Note on Python 2" section stated that extras_require MUST include azure-nspkg for Python 2. Python 2 support was dropped on January 1st 2022; this requirement no longer applies. Reworded the section header and added an explicit obsolete notice.
doc/dev/static_type_checking.md
  • Updated stale Python 2 type hint note: The note said "some libraries use comment-style type hints due to legacy Python 2 code, but these will be updated." Since Python 2 support has been dropped, this "future work" framing is no longer accurate. Updated to simply state that annotation-style hints are required as Python 2 is no longer supported.

Generated by Documentation Consistency Check · 174.8 AIC · ⌖ 12.8 AIC · ⊞ 5.8K · ◷

[!NOTE]
This was originally intended as a pull request, but GitHub Actions is not permitted to create or approve pull requests in this repository.
The changes have been pushed to branch doc/fix-documentation-inconsistencies-5c0669ae2af3aeb2.

Click here to create the pull request

To fix the permissions issue, go to Settings → Actions → General and enable Allow GitHub Actions to create and approve pull requests. See also: gh-aw FAQ

Show patch preview (133 of 133 lines) 
From a48db3de1146963ef663f318c1d8a1c39553ad78 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 17 Aug 2026 05:02:13 +0000
Subject: [PATCH] doc: fix documentation inconsistencies in dev guides

- tests.md: fix numbered list skipping from 2 to 4 (two occurrences)
- tests.md: update Python 3.14 (unreleased) venv example to Python 3.13
- mgmt/generation.md: remove unnecessary 'pip install setuptools' step
- mgmt/generation.md: replace deprecated 'python setup.py bdist_wheel'
  with 'python -m build'
- packaging.md: update version.py -> _version.py and README.rst -> README.md
  in legacy setup.py example to match current package conventions
- packaging.md: mark 'Note on Python 2 / azure-nspkg' section as obsolete
  since Python 2 support was dropped in 2022
- static_type_checking.md: update stale note about Python 2 comment-style
  type hints to reflect that Python 2 is no longer supported

Co-authored-by: Copilot <[email protected]>
---
 doc/dev/mgmt/generation.md      |  3 +--
 doc/dev/packaging.md            | 10 ++++++----
 doc/dev/static_type_checking.md |  2 +-
 doc/dev/tests.md                |  8 ++++----
 4 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/doc/dev/mgmt/generation.md b/doc/dev/mgmt/generation.md
index 73cb1553..6d3767d6 100644
--- a/doc/dev/mgmt/generation.md
+++ b/doc/dev/mgmt/generation.md
@@ -57,7 +57,6 @@ PS C:\dev\azure-sdk-for-python> .\.venv\Scripts\Activate.ps1  # Windows
 3. Install Python dependencies:

(.venv) PS C:\dev\azure-sdk-for-python> python .\scripts\dev_setup.py -p azure-core
-(.venv) PS C:\dev\azure-sdk-for-python> pip install setuptools


### Generate the SDK
@@ -179,7 +178,7 @@ If you're doing basic testing and want to minimal set of parameters:

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.


... (truncated)
Ngôn ngữ chính
Python
Star
5.6k
Fork
3.4k
Merge trung bình
2 ngày 1 giờ
Pull request đã merge (30 ngày)
213

Chuẩn bị môi trường

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Azure/azure-sdk-for-python

Tất cả issue của Azure/azure-sdk-for-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.