aws / aws/aws-xray-sdk-python

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

Aperta
#286 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
bug documentation
Lingua principale
Python
Stelle
338
Fork
147
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Bug
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.