You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This PR fixes three inconsistencies found in the developer documentation under doc/:
1. Broken conftest.py link in doc/dev/mgmt/tests.md
The link pointed to sdk/advisor/azure-mgmt-advisor/tests/conftest.py, which does not exist in the repository. The azure-mgmt-advisor package uses auto-generated tests, and the conftest lives at sdk/advisor/azure-mgmt-advisor/generated_tests/conftest.py.
Fix: Updated the URL to point to the correct generated_tests/conftest.py path.
2. Stale line-number anchors in doc/dev/pylint_checking.md
The guide linked to specific line numbers in eng/tools/azure-sdk-tools/azpysdk/pylint.py to show where the pinned pylint version and the azure-pylint-guidelines-checker version are defined. Both anchors were off:
Fix: Updated the anchors to match the current line numbers.
3. Outdated Python 2 reference in doc/dev/static_type_checking.md
A note said type comments are used in "legacy code supporting Python 2". Python 2 support was dropped years ago and no active library in this repo uses comment-style type hints for Python 2 compatibility.
Fix: Simplified the note to just say "Use inline annotation style instead."
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-inconsistencies-2026-092e77602d1e7e2b.
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 (65 of 65 lines)
From a4108fe3f6e7e1fca1575d0c3a3dad3dbae9da64 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 20 Jul 2026 05:56:10 +0000
Subject: [PATCH] doc: fix inconsistencies in developer documentation
- Fix broken link in doc/dev/mgmt/tests.md: conftest.py example
pointed to sdk/advisor/azure-mgmt-advisor/tests/conftest.py which
does not exist; corrected to generated_tests/conftest.py
- Fix stale line-number anchors in doc/dev/pylint_checking.md:
pylint.py#L17 -> #L16 (PYLINT_VERSION) and #L61 -> #L70
(azure-pylint-guidelines-checker install line)
- Remove outdated Python 2 reference in doc/dev/static_type_checking.md:
the note about type comments being used for Python 2 legacy code is
no longer relevant since Python 2 support was dropped
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
doc/dev/mgmt/tests.md | 2 +-
doc/dev/pylint_checking.md | 2 +-
doc/dev/static_type_checking.md | 2 +-
3 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/doc/dev/mgmt/tests.md b/doc/dev/mgmt/tests.md
index 7f7bfdd4..7328a29b 100644
--- a/doc/dev/mgmt/tests.md+++ b/doc/dev/mgmt/tests.md@@ -153,7 +153,7 @@ Management plane SDKs are those that are formatted `azure-mgmt-xxxx`, otherwise
### Tips:
After the migration of the test proxy, `conftests.py` needs to be configured under the tests folder.<br/>
-* For a sample about `conftest.py`, see [conftest.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/advisor/azure-mgmt-advisor/tests/conftest.py). <br/>+* For a sample about `conftest.py`, see [conftest.py](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/advisor/azure-mgmt-advisor/generated_tests/conftest.py). <br/>
* For more information about test proxy, see [TestProxy][testproxy].
### Example 1: Basic Azure service interaction and recording
diff --git a/doc/dev/pylint_checking.md b/doc/dev/pylint_checking.md
index 7bee34e3..190eedf2
... (truncated)
Summary
This PR fixes three inconsistencies found in the developer documentation under
doc/:1. Broken
conftest.pylink indoc/dev/mgmt/tests.mdThe link pointed to
sdk/advisor/azure-mgmt-advisor/tests/conftest.py, which does not exist in the repository. Theazure-mgmt-advisorpackage uses auto-generated tests, and the conftest lives atsdk/advisor/azure-mgmt-advisor/generated_tests/conftest.py.Fix: Updated the URL to point to the correct
generated_tests/conftest.pypath.2. Stale line-number anchors in
doc/dev/pylint_checking.mdThe guide linked to specific line numbers in
eng/tools/azure-sdk-tools/azpysdk/pylint.pyto show where the pinned pylint version and theazure-pylint-guidelines-checkerversion are defined. Both anchors were off:#L17→#L16(PYLINT_VERSION = "4.0.4")#L61→#L70(azure-pylint-guidelines-checker==0.5.7)Fix: Updated the anchors to match the current line numbers.
3. Outdated Python 2 reference in
doc/dev/static_type_checking.mdA note said type comments are used in "legacy code supporting Python 2". Python 2 support was dropped years ago and no active library in this repo uses comment-style type hints for Python 2 compatibility.
Fix: Simplified the note to just say "Use inline annotation style instead."
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-inconsistencies-2026-092e77602d1e7e2b.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 (65 of 65 lines)