Broken link in Python SDK docs (aws_xray_sdk.core package)
Chưa có ai nhận issue này.
Đánh giá
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 ngày
- Mức phù hợp với người mới
- 35/100
- Loại issue
- Lỗi
- Độ rõ ràng
- Khá rõ ràng
- Mức độ hoạt động
- Đình trệ
- Công nghệ
- python
- Lĩnh vực
- documentation
Hướng nghiên cứu
Bắt đầu với aws_xray_sdk/core/daemon_config.py và kiểm tra cách chú thích DaemonConfig trở thành trang chỉ mục mô-đun được tạo tại URL tài liệu AWS X-Ray SDK được liên kết. Xác định xem trình tạo hay chú thích mã nguồn tạo ra liên kết tcp:127.0.0.1:2000 ngoài ý muốn, sau đó xác minh rằng tài liệu đã xuất bản hiển thị địa chỉ đó dưới dạng văn bản thuần túy.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
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.
- Ngôn ngữ chính
- Python
- Star
- 339
- Fork
- 147
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của aws/aws-xray-sdk-python
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
aws/aws-xray-sdk-python#490 · 1 bình luận ·
-
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 1/100
aws/aws-xray-sdk-python#460 ·
-
Next release Đang mở
Độ khó 5/5 Hơn một tuần Mức phù hợp với người mới 20/100
aws/aws-xray-sdk-python#457 · 1 reaction ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 35/100
aws/aws-xray-sdk-python#453 ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 35/100
aws/aws-xray-sdk-python#452 · 1 reaction ·
Tất cả issue của aws/aws-xray-sdk-python
Issue tương tự
-
agent-ready documentation needs-triage
Độ khó 1/5 1-3 giờ Mức phù hợp với người mới 88/100
-
documentation
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Đang mở
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
-
Add https://search.jeremyh.xyz/ Đang mởinstance instance add
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 72/100
searxng/searx-instances#939 · 1 bình luận ·
-
area-deployment area-integrations triage:bot-seen
Độ khó 2/5 Nửa ngày Mức phù hợp với người mới 86/100