Broken link in Python SDK docs (aws_xray_sdk.core package)
- Lenguaje dominante
- Python
- Estrellas
- 338
- Forks
- 147
- Métricas de merge de PR
- Sin PR fusionados en 30 d
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 ‘\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.
Guía de contribución
Línea de trabajo
Start with aws_xray_sdk/core/daemon_config.py and inspect how its DaemonConfig comment becomes the generated module-index page at the linked AWS X-Ray SDK docs URL. Determine whether the generator or source comment creates the unintended tcp:127.0.0.1:2000 link, then verify the published documentation renders that address as plain text.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- python
- Área
- documentation
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100