aws / aws/aws-xray-sdk-python

Broken link in Python SDK docs (aws_xray_sdk.core package)

Ouverte
#286 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
bug documentation
Langage dominant
Python
Étoiles
338
Forks
147
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
documentation
Type d'issue
Bug
Difficulté
3/5
Temps estimé
1-2 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.