Azure / Azure/azure-sdk-for-python

[docs] Fix documentation inconsistencies in doc/ folder

Aperta
#48,807 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
agentic-workflows automated documentation
Lingua principale
Python
Stelle
5.6k
Fork
3.4k
Merge medio
2g 2h
PR unite (30g)
213

Descrizione

Fixes four verified documentation inconsistencies found by reviewing all markdown files under `doc/` against the current repository structure and source code.

## Changes

### `doc/dev/perfstress_tests.md`
The system-tests install command referenced a `tools/devtools_testutils` path that **does not exist** in the repository. The actual path is `eng/tools/azure-sdk-tools`.

**Before:**
```
pip install -e azure-sdk-for-python/tools/devtools_testutils[systemperf]
```
**After:**
```
pip install -e azure-sdk-for-python/eng/tools/azure-sdk-tools[systemperf]
```

### `doc/dev/conda-builds.md`
The file referenced `eng/conda_env.yml` which **does not exist**. The file lives at `conda/conda-recipes/conda_env.yml`.

### `doc/dev/pylint_checking.md`
The link for `azure-pylint-guidelines-checker` pointed to line `#L61` of `pylint.py`, which is the `register()` method body — unrelated to the version. The `PYLINT_GUIDELINES_CHECKER_VERSION` constant is at line `#L18`.

### `doc/dev/tests.md`
Three reference links for `kv_test_resources` pointed to a SHA-pinned, now-deleted `test-resources.json` file in the Key Vault SDK. That file was replaced by `test-resources.bicep`. Updated all three links to point to the current `test-resources.bicep` file on `main`, with corrected line anchors for the resources section (line 38) and outputs section (line 174).

> Generated by [Documentation Consistency Check](https://github.com/Azure/azure-sdk-for-python/actions/runs/33358307244) · 199.1 AIC · ⌖ 12.6 AIC · ⊞ 5.8K · [◷](https://github.com/search?q=repo%3AAzure%2Fazure-sdk-for-python+%22gh-aw-workflow-id%3A+doc-consistency-check%22&type=pullrequests)

---

> [!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-22e1d1be83f5f3d2`.
>
> **[Click here to create the pull request](https://github.com/Azure/azure-sdk-for-python/compare/main...doc/fix-documentation-inconsistencies-22e1d1be83f5f3d2?expand=1&title=%5Bdocs%5D%20Fix%20documentation%20inconsistencies%20in%20doc%2F%20folder)**

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](https://github.github.com/gh-aw/reference/faq/#why-is-my-create-pull-request-workflow-failing-with-github-actions-is-not-permitted-to-create-or-approve-pull-requests)

Show patch preview (82 of 82 lines)

```diff
From e0ffa714c6c5f4def2e3b1b9346ce3d302da544e Mon Sep 17 00:00:00 2001
From: "github-actions[bot]"
Date: Mon, 31 Aug 2026 04:55:20 +0000
Subject: [PATCH] doc: fix documentation inconsistencies

- perfstress_tests.md: fix install path from non-existent tools/ to
eng/tools/azure-sdk-tools
- conda-builds.md: fix conda_env.yml path from eng/ to
conda/conda-recipes/
- pylint_checking.md: fix stale line anchor #L61 to #L18 for
PYLINT_GUIDELINES_CHECKER_VERSION
- tests.md: update kv_test_resources links from SHA-pinned deleted
test-resources.json to main-branch test-resources.bicep

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
---
doc/dev/conda-builds.md | 2 +-
doc/dev/perfstress_tests.md | 2 +-
doc/dev/pylint_checking.md | 2 +-
doc/dev/tests.md | 6 +++---
4 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/doc/dev/conda-builds.md b/doc/dev/conda-builds.md
index 72e845ce..085e8b34 100644
--- a/doc/dev/conda-builds.md
+++ b/doc/dev/conda-builds.md
@@ -12,7 +12,7 @@ Follow the instructions [here](https://docs.conda.io/projects/conda-build/en/lat

- Update `CondaArtifacts` parameters as necessary within `eng/pipelines/templates/stages/conda-sdk-client.yml` .
- If necessary, add or update the conda recipes present under `/conda/conda-recipes`.
-- Update `eng/conda_env.yml` variable `AZURESDK_CONDA_VERSION` to the target version you wish to release.
+- Update `conda/conda-recipes/conda_env.yml` variable `AZURESDK_CONDA_VERSION` to the target version you wish to release.
- Invoke [python - conda](https://dev.azure.com/azure-sdk/internal/_build?definitionId=6321) manually, checking off which packages you wish to release.
- Once built, approve the packages for release individually, there will be pending approval stages.

diff --git a/doc/dev/perfstress_tests.md b/doc/dev/perfstress_tests.md
index c0f7fa85..fe3ded40 100644
--- a/doc/dev/perfstress_tests.md
+++ b/doc/
... (truncated)
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Esamina doc/dev/perfstress_tests.md, doc/dev/conda-builds.md, doc/dev/pylint_checking.md e doc/dev/tests.md confrontandoli con i percorsi del repository e i file sorgente collegati. Verifica ogni percorso referenziato, ogni ancora di versione e ogni collegamento a una risorsa Key Vault, quindi conferma che tutti e quattro i documenti contengano riferimenti aggiornati; il lavoro è già staged sul branch indicato per una pull request.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.