MIT-LCP / MIT-LCP/wfdb-python

Missing docs for rdedfann (and other functions)

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

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

Ngôn ngữ chính
Jupyter Notebook
Star
853
Fork
322
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The function wfdb.rdedfann (alias wfdb.io.rdedfann) is not listed in the public documentation.

Make a list here of other functions that should be considered part of the public API, but are not listed in docs/wfdb.rst / docs/io.rst / docs/plot.rst / docs/processing.rst.

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.

Hướng nghiên cứu

Bắt đầu bằng cách so sánh các hàm công khai trong gói wfdb với các mục API trong docs/wfdb.rst, docs/io.rst, docs/plot.rst và docs/processing.rst, bắt đầu từ wfdb.rdedfann và bí danh wfdb.io.rdedfann của nó. Xác định các hàm công khai khác còn thiếu trong những tài liệu này và cập nhật tài liệu API liên quan để liệt kê API được xem là công khai.

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
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
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.