Tracking issue for specification maintenance tasks

Đang mở
#533 6 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ó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tái cấu trúc
Độ 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 checklist còn lại và issue #519, sau đó kiểm tra các nguồn đặc tả và cấu hình định dạng hoặc CI hiện có được đề cập trong issue này. Công việc được hoàn tất khi các trường hợp đặc biệt đã được chuyển đổi và độ dài dòng được xử lý nhất quán, với các tác vụ đã hoàn thành được phản ánh trong tracker này.

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

Mô tả

Maintenance Tracking Issue

The purpose of this issue is to identify and track various maintenance tasks which have accumulated concerning specification organization and development.

Remaining tasks
  • Migrate special cases to use math directives: https://github.com/data-apis/array-api/issues/519
  • Ensure line length is handled better, so text is readable and reviewable on GitHub without it scrolling off to the right. Either use regular line length settings (80, 88, 100, or 120 char), or set up something like EditorConfig to ensure consistent line endings and spacing.
  • Setup linting of Python files (black, pydocstyle) in CI.
Done for v2022
  • Move special cases and other explanatory content to a dedicated "notes" section: https://github.com/data-apis/array-api/issues/518
    • PR: gh-578
  • Add a short sentence about whether the special cases are derived from C99, from some other standard, or are based on analysis or existing practice in array libraries. See https://github.com/data-apis/array-api/pull/514#issuecomment-1337650301.
    • PR: gh-579
  • Use black for automated code formatting and line wrapping (possibly using Git hooks).
    • PR: gh-575
  • Move universal preamble content (e.g., positional parameters, optional parameters, etc) to a dedicated design document.
    • PR: gh-576
  • Merge the content in the "branch cuts", "complex number ordering" and "complex numbers" (about equality mostly) design topic pages into a single "complex number support" page.
Ngôn ngữ chính
Python
Star
281
Fork
52
Không có pull request nào được merge trong 30 ngày

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 data-apis/array-api

Tất cả issue của data-apis/array-api

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.