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

[docs] Fix outdated API references in doc/dev/mgmt/tests.md

Abierto
  • ¿Algo no está bien?
#48,400 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
1/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
25/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Estancado
Stack tecnológico
azure, python
Área
documentation

Línea de trabajo

Revisa doc/dev/mgmt/tests.md comparándolo con la API actual de azure-identity y con los nombres de las funciones auxiliares de mgmt_settings_fake.py. Confirma que los parámetros de credenciales, las funciones auxiliares y las referencias a las clases de casos de prueba coincidan con el código fuente y, después, verifica que los ejemplos documentados sean internamente coherentes.

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

Descripción

agentic-workflows automated documentation

Summary

Reviewed all markdown files under doc/ and doc/dev/ for inconsistencies with the current source code. One file had outdated API references.

Changes in doc/dev/mgmt/tests.md
Issue Fix
ClientSecretCredential(secret=...) Changed to client_secret= (correct parameter name per azure-identity)
ClientSecretCredential(tenant=...) Changed to tenant_id= (correct parameter name per azure-identity)
get_azure_core_credential() (singular) Changed to get_azure_core_credentials() (plural) — matches mgmt_settings_fake.py
get_credential() (singular) Changed to get_credentials() (plural) — matches actual helper function name
AzureTestCase class reference Changed to AzureMgmtRecordedTestCase — AzureTestCase no longer exists
Files verified clean (no changes needed)
  • doc/README.md, doc/dev/README.md, doc/tool_usage_guide.md
  • doc/dev/tests.md, doc/dev/dev_setup.md, doc/dev/release.md
  • doc/dev/pylint_checking.md, doc/dev/static_type_checking.md, doc/dev/static_type_checking_cheat_sheet.md
  • All other doc/ and doc/dev/ markdown files

No stale tox references were found (docs already use azpysdk). No broken internal links. No setup.py vs pyproject.toml mismatches.

Generated by Documentation Consistency Check · 262.9 AIC · ⌖ 12.2 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-mgmt-tests-api-references-b4c97c893c05f6c0.

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 (62 of 62 lines) 
From d395145311ea7297a2733317323e2dcefbc2e155 Mon Sep 17 00:00:00 2001
From: "github-actions[bot]" <github-actions[bot]@users.noreply.github.com>
Date: Mon, 3 Aug 2026 06:05:28 +0000
Subject: [PATCH] Fix outdated API references in doc/dev/mgmt/tests.md

- Fix ClientSecretCredential parameter names: secret= -> client_secret=, tenant= -> tenant_id=
- Fix function name references: get_azure_core_credential -> get_azure_core_credentials, get_credential -> get_credentials
- Fix class reference: AzureTestCase -> AzureMgmtRecordedTestCase

Co-authored-by: Copilot <[email protected]>
---
 doc/dev/mgmt/tests.md | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/dev/mgmt/tests.md b/doc/dev/mgmt/tests.md
index 7f7bfdd4..44e71108 100644
--- a/doc/dev/mgmt/tests.md
+++ b/doc/dev/mgmt/tests.md
@@ -77,8 +77,8 @@ from azure.identity import ClientSecretCredential
 
 credentials = ClientSecretCredential(
     client_id = os.environ['AZURE_CLIENT_ID'],
-    secret = os.environ['AZURE_CLIENT_SECRET'],
-    tenant = os.environ['AZURE_TENANT_ID']
+    client_secret = os.environ['AZURE_CLIENT_SECRET'],
+    tenant_id = os.environ['AZURE_TENANT_ID']
 )

Or you can use DefaultAzureCredential, which we prefer.
@@ -98,9 +98,9 @@ In live mode, you need to use real credentials like those you obtained in the pr
Then make the following changes:

  • Change the value of the SUBSCRIPTION_ID constant to your subscription ID. (If you don't have it, you can find it in the "Overview" section of the "Subscriptions" blade in the [Azure portal][azure_portal].)
    -* Change the get_azure_core_credential() function to construct and return a ClientSecretCredential:
    +* Change the get_azure_core_credentials() function to construct and return a ClientSecretCredential:
-def get_azure_core_credential(**kwargs):
+def get_azure_core_credentials(**kwargs):
    from azure.identity import ClientSecretCredential
    import os
    
... (truncated)
Lenguaje dominante
Python
Estrellas
5.6k
Forks
3.4k
Merge medio
1 d 18 h
PR fusionados (30 d)
214

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.