Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

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

Aperta
#286 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

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

Direzione di ricerca

Inizia da aws_xray_sdk/core/daemon_config.py e verifica come il commento di DaemonConfig diventa la pagina dell’indice dei moduli generata all’URL collegato della documentazione di AWS X-Ray SDK. Determina se il generatore o il commento nel codice sorgente crea il collegamento indesiderato tcp:127.0.0.1:2000, quindi verifica che la documentazione pubblicata visualizzi quell’indirizzo come testo normale.

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

Descrizione

bug documentation

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.

Lingua principale
Python
Stelle
339
Fork
147
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di aws/aws-xray-sdk-python

Tutte le issue di aws/aws-xray-sdk-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.