Being more explicit with documenting public API

Đang mở
#2,235 3 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tính năng
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
api, developer-experience

Hướng nghiên cứu

Bắt đầu bằng cách xem xét cuộc thảo luận trong pull request #2234 và phần PEP-8 được liên kết trong issue. Xác định các trường hợp sử dụng cụ thể cho việc khai báo API công khai trong mã nguồn Python, bao gồm ảnh hưởng đã được nêu đối với star imports; công việc được xem là hoàn tất khi đã thống nhất về hướng đi và phạm vi, chứ không phải khi có một bản vá triển khai.

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

Mô tả

Description of issue or feature request:

As a result of discussion in https://github.com/theupdateframework/python-tuf/pull/2234, opening this issue to make consensus on eventually declaring public API directly in Python sources.

Current behavior:

Developers can explore API provided by python-tuf using RTD pages. As per PEP-8 standard, __all__ could be considered to declare public API. Note by doing so, this also affects start imports.

Expected behavior:

Identify possible use-cases for declaring public API in Python sources.

Ngôn ngữ chính
Python
Star
1.7k
Fork
304
Merge trung bình
1 ngày 2 giờ
Pull request đã merge (30 ngày)
17

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

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

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của theupdateframework/python-tuf

Tất cả issue của theupdateframework/python-tuf

Issue tương tự

Thêm issue về Python

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.