Skip to content

docs: escape tcp daemon address in docstring to prevent broken link #494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
reginaldalfret wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: escape tcp daemon address in docstring to prevent broken link #494

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions aws_xray_sdk/core/daemon_config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,10 @@ class DaemonConfig:
the ip address and port for UDP and TCP port. It gets the address
string from ``AWS_TRACING_DAEMON_ADDRESS`` and then from recorder's
configuration for ``daemon_address``.
A notation of '127.0.0.1:2000' or 'tcp:127.0.0.1:2000 udp:127.0.0.2:2001'
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.
By default it assumes a X-Ray daemon running at 127.0.0.1:2000
By default it assumes a X-Ray daemon running at ``127.0.0.1:2000``
listening to both UDP and TCP traffic.
"""
def __init__(self, daemon_address=DEFAULT_ADDRESS):
Expand Down