Broken link in Python SDK docs (aws_xray_sdk.core package)
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Aptitud para principiantes
- 35/100
- Tipo de issue
- Error
- Claridad
- Bastante claro
- Estado de actividad
- Estancado
- Stack tecnológico
- python
- Área
- documentation
Línea de trabajo
Comience con aws_xray_sdk/core/daemon_config.py e inspeccione cómo el comentario de DaemonConfig se convierte en la página de índice de módulos generada en la URL vinculada de la documentación de AWS X-Ray SDK. Determine si el generador o el comentario del código fuente crea el enlace no intencionado tcp:127.0.0.1:2000 y, después, verifique que la documentación publicada muestra esa dirección como texto sin formato.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
There's now a broken link on this page of the module index in the Python SDK docs: https://docs.aws.amazon.com/xray-sdk-for-python/latest/reference/aws_xray_sdk.core.html#module-aws_xray_sdk.core
The link 'tcp:127.0.0.1:2000' appears to be unintentional, and is being generated from the comment for class DaemonConfig here: https://github.com/aws/aws-xray-sdk-python/blob/master/aws_xray_sdk/core/daemon_config.py
Doc source from code:
class DaemonConfig(object):
"""...
A notation of '127.0.0.1:2000' or 'tcp:127.0.0.1:2000 udp:127.0.0.2:2001'
are both acceptable. The former one means UDP and TCP are running at
the same address.
...
"""
Resulting HTML output in SDK docs:
A notation of ‘127.0.0.1:2000’ or ‘<a class="reference external" href="tcp:127.0.0.1:2000">tcp:127.0.0.1:2000</a> udp:127.0.0.2:2001’ are both acceptable. The former one means UDP and TCP are running at the same address.
Potential fixes:
This class file hasn't been changed in over two years, so my best guess is that the doc generator is the source of the issue. I'm not sure of the appropriate fix; whether there's a way to escape the comment in the code somehow, or to modify the SDK doc generator to avoid this in future.
- Lenguaje dominante
- Python
- Estrellas
- 339
- Forks
- 147
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de aws/aws-xray-sdk-python
-
Dificultad 3/5 1-2 días Aptitud para principiantes 68/100
aws/aws-xray-sdk-python#490 · 1 comentario ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 1/100
aws/aws-xray-sdk-python#460 ·
-
Next releaseAbierto
Dificultad 5/5 Más de una semana Aptitud para principiantes 20/100
aws/aws-xray-sdk-python#457 · 1 reacción ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 35/100
aws/aws-xray-sdk-python#453 ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
aws/aws-xray-sdk-python#452 · 1 reacción ·
Todos los issues de aws/aws-xray-sdk-python
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
-
bug
Dificultad 1/5 Menos de una hora Aptitud para principiantes 88/100
qgis/QGIS-Plugins-Website#459 ·
-
bug severity:medium
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
Los mantenedores suelen responder en 2 días
-
bot-found bug priority: P3
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
madenvel/KalinkaPlayer#179 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
ls1intum/edutelligence#1098 ·
Los mantenedores suelen responder en 1 día