Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

[docs] Fix documentation inconsistencies in dev guides

Abierto
  • ¿Algo no está bien?
#48,600 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
3/5
Tiempo estimado
1-2 días
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
documentation

Línea de trabajo

Revisa doc/dev/tests.md, doc/dev/mgmt/generation.md, doc/dev/packaging.md y doc/dev/static_type_checking.md comparándolos con el código fuente actual y las convenciones del repositorio descritas en el issue. Verifica los cambios indicados en las instrucciones sobre versiones, compilación, packaging, numeración y Python 2, y confirma después que los cuatro documentos no contienen ninguna inconsistencia restante.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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)
Lenguaje dominante
Python
Estrellas
5.6k
Forks
3.4k
Merge medio
1 d 18 h
PR fusionados (30 d)
202

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Azure/azure-sdk-for-python

Todos los issues de Azure/azure-sdk-for-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.