aws / aws/aws-xray-sdk-python

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

Open
#286 1 comment 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Python
Stars
338
Forks
147
PR merge metrics
No merged PRs in 30d

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.