Document Structure and Wishlist

Đang mở
#845 1 bình luận 4 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
20/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Xem xét các phần Tutorials, /guides, /reference, /spec và Links ở cấp cao nhất được đề xuất, cùng với các issue được liên kết #891, #905 và #851. Xác định công việc tài liệu nào còn lại và chia danh sách mong muốn rộng này thành các nhiệm vụ cụ thể, có thể thực hiện; việc hoàn thành chưa được định nghĩa cho issue hiện tại.

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

Mô tả

topic: documentation

Here is how I envision the typing documentation to be structured:

Tutorials

User-facing basic and advanced introductions to the type system or particular aspects of it. Non-comprehensive.

  • Typing tutorial – from the ground up (#891)
  • Type stub tutorial – writing a type stub for an existing library, stubgen, contributing to typeshed

Howto Guides

Directory: /guides

User-facing guides to accomplish particular tasks.

  • How to add typing to an existing code base
  • How to annotate a library (#905)

Reference

Directory: /reference

User-facing, comprehensive reference of the type system.

  • Link to the typing module documentation
    • Probably needs a review
  • #851
  • Type stub syntax and supported constructs
  • Type stub style guide

Type System Specification

Directory: /spec

Territory of the Typing Council. Targeted at type checker developers. Here be dragons. 🐉

Links

Top level.

  • Links to all typing-related PEPs
  • Links to type checkers and other typing tools

Additions, corrections, criticism welcome!

2014-09-02: Updated to reflect the addition of the type system spec. Also, added explanations to the categories.

Ngôn ngữ chính
Python
Star
1.8k
Fork
302
Merge trung bình
23 giờ
Pull request đã merge (30 ngày)
8

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

Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này

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 python/typing

Tất cả issue của python/typing

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.