aws / aws/aws-encryption-sdk-python

Sphinx does not follow paths for class aliases for parameter types

Đang mở
#61 2 bình luận 0 reaction 0 người được giao Xem trên GitHub
good first issue help wanted maintenance
Ngôn ngữ chính
Python
Star
255
Fork
92
Merge trung bình
2 ngày 17 giờ
Pull request đã merge (30 ngày)
2

Mô tả

## Problem
Even though `Algorithm` is an alias for `AlgorithmSuite`, it looks like the sphinx module that generates code links for parameter types doesn't realize that and just treats it as an unknown class.

ex:

render:

https://aws-encryption-sdk-python.readthedocs.io/en/latest/generated/aws_encryption_sdk.html#aws_encryption_sdk.encrypt

src:

https://github.com/aws/aws-encryption-sdk-python/blob/master/src/aws_encryption_sdk/__init__.py#L72-L73

## Solution
Replace parameter type references with `AlgorithmSuite`.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

Kiểm tra các định nghĩa bí danh trong src/aws_encryption_sdk/__init__.py ở dòng 72-73, sau đó so sánh tài liệu mã hóa được tạo với liên kết nguồn của nó. Truy vết module Sphinx tạo các liên kết đến kiểu tham số và xác minh rằng tham chiếu tham số được phân giải thành AlgorithmSuite thay vì một class không xác định.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
documentation
Loại issue
Lỗi
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.