Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

[docs] docs: fix inconsistencies between doc/ and current source code

オープン
  • 何か問題がありますか？
#49,220 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

@wasim-builds がすでに取り組んでいます。

2026年10月4日 から。

  • #49346 @wasim-builds による — オープン

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
10/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
python
領域
documentation

調査の方向性

Review the listed files under doc/, including tool_usage_guide.md, analyze_check_versions.md, eng_sys_checks.md, request_builders.md, and the dev/ pages, against the referenced Python source and pipeline files. Start with the existing branch docs/fix-doc-inconsistencies-72041-bfbb16928a7b7e88 and verify each documented claim against the current implementation. Done means the documented commands, paths, names, versions, links, and workflows match the source without unrelated edits.

索引モデルが issue の本文から書いたものです。

説明

agentic-workflows automated documentation

[!TIP]
Your pull request is ready to create! 🎉 ✅

Everything is OK—the changes have been pushed to branch docs/fix-doc-inconsistencies-72041-bfbb16928a7b7e88. Please review the changes, including any protected files, before creating the pull request.

Create the pull request

The original pull request description is below.

Summary

Reviewed all markdown files under doc/ against the current source code (eng/tools/azure-sdk-tools, eng/scripts, sdk/core/azure-core, pipeline templates, etc.) and fixed the verifiable inconsistencies found. No unrelated changes were made.

Fixes

  • doc/tool_usage_guide.md: The azpysdk command table was missing several existing subcommands. Added rows for whl, whl_no_aio, sdist, mindependency, latestdependency, and changelog (all confirmed present in eng/tools/azure-sdk-tools/azpysdk/main.py).
  • doc/analyze_check_versions.md: Fixed a malformed Markdown table (rows were missing their leading |), and corrected the Pylint Guidelines Checker "Next Version" from 0.5.7 to 0.5.9 to match NEXT_PYLINT_GUIDELINES_CHECKER_VERSION in eng/tools/azure-sdk-tools/azpysdk/pylint.py.
  • doc/eng_sys_checks.md: Corrected claims that mindependency runs in PR/Nightly/Release builds. It is currently commented out of both PR_BUILD_SET and FULL_BUILD_SET in eng/scripts/set_checks.py pending CFS onboarding (tracked in #48346); added a note pointing to the tracking issue.
  • doc/request_builders.md: Fixed response.text to response.text() — HttpResponse.text is a method (see azure/core/rest/_rest_py3.py / _http_response_impl.py), not a property. (This already matched correctly in the sibling doc/send_request.md.)
  • doc/dev/perfstress_tests.md: Fixed a stale install path for the systemperf extra. devtools_testutils (and its systemperf extra) now live under eng/tools/azure-sdk-tools, not tools/devtools_testutils.
  • doc/dev/conda-builds.md: Replaced an instruction to manually edit a nonexistent eng/conda_env.yml file with an accurate description of the automated conda-update-pipeline.yml / conda/update_conda_files.py flow (the real version file lives at conda/conda-recipes/conda_env.yml and is already documented correctly in doc/dev/conda-release-dev.md).
  • doc/dev/mgmt/tests.md: Fixed stale function/class names to match current source in eng/tools/azure-sdk-tools/devtools_testutils/mgmt_settings_fake.py and mgmt_recorded_testcase.py:
    • get_azure_core_credential() → get_azure_core_credentials()
    • get_credential() → get_credentials()
    • AzureTestCase → AzureMgmtRecordedTestCase

Verification

  • Checked every relative Markdown link/image reference under doc/ resolves to an existing file (no broken internal links remain beyond one pre-existing regex snippet inside a code block that is not an actual link).
  • Cross-referenced tool/version/command claims against the current implementation in eng/tools/azure-sdk-tools/azpysdk/*.py, eng/scripts/set_checks.py, and sdk/core/azure-core.
  • Reviewed doc/dev/mgmt/*, doc/dev/conda-*, doc/dev/ai/*, and the remaining top-level doc/*.md files; no further verifiable inconsistencies were found (the rest of the documentation matches current tooling, e.g. azpysdk-based workflows, pyproject.toml-based packaging, and Chronus changelog usage).

[!NOTE]
GitHub Actions is not permitted to create or approve pull requests in this repository.

The changes have been pushed to branch docs/fix-doc-inconsistencies-72041-bfbb16928a7b7e88 and are ready to review.

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 (38 of 186 lines) 
From 07a9db1d2c399c7d35965425c7e7b56d9fb58c10 Mon Sep 17 00:00:00 2001
X-GH-AW-Base-Commit: 1053b0652a66b30d3d51844320b54af22600b50b
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 28 Sep 2026 05:07:36 +0000
Subject: [PATCH] docs: fix inconsistencies between doc/ and current source
 code

- tool_usage_guide.md: add missing azpysdk commands to the tool table
  (whl, whl_no_aio, sdist, mindependency, latestdependency, changelog)
- analyze_check_versions.md: fix malformed table (missing leading `|`)
  and correct the Pylint Guidelines Checker "Next Version" (0.5.7 ->
  0.5.9, matching NEXT_PYLINT_GUIDELINES_CHECKER_VERSION in pylint.py)
- eng_sys_checks.md: correct references to `mindependency` running in
  PR/Nightly/Release builds -- it is currently commented out of
  PR_BUILD_SET/FULL_BUILD_SET in eng/scripts/set_checks.py pending
  CFS onboarding (issue #48346)
- request_builders.md: fix `response.text` to `response.text()`, since
  HttpResponse.text is a method, not a property (see azure-core's
  azure/core/rest/_rest_py3.py)
- dev/perfstress_tests.md: fix stale install path for the `systemperf`
  extra; it lives at eng/tools/azure-sdk-tools[systemperf], not
  tools/devtools_testutils[systemperf]
- dev/conda-builds.md: replace the stale manual instruction to edit a
  nonexistent eng/conda_env.yml with an accurate description of the
  automated conda-update-pipeline.yml / update_conda_files.py flow
- dev/mgmt/tests.md: fix function/class name typos
  (get_azure_core_credential -> get_azure_core_credentials,
  get_credential -> get_credentials, AzureTestCase ->
  AzureMgmtRecordedTestCase) to match
  devtools_testutils/mgmt_settings_fake.py and mgmt_recorded_testcase.py

Co-authored-by: Copilot <[email protected]>
---
 doc/analyze_check_versions.md | 12 ++++++------
 doc/dev/conda-builds.md       |  2 +-
 doc/dev/mgmt/tests.md         | 10 +++++-----
 doc/dev/perfstress_tests.md   |  2 +-
 doc/eng_sys_ch
... (truncated)

Generated by Documentation Consistency Check · copilot · sonnet50 · 500.9 AIC · ⌖ 6.8 AIC · ⊞ 7.7K · ◷

主要言語
Python
スター
5.6k
フォーク
3.4k
平均マージ
2日 12時間
マージ済み PR（30日）
210

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

Azure/azure-sdk-for-python のほかの issue

Azure/azure-sdk-for-python の issue をすべて見る

似ている issue

Python の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。