Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Improve examples in docstrings

Đang mở
  • Có gì không ổn?
#434 0 bình luận 1 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
42/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

Bắt đầu bằng việc xem xét pull request #433 và các docstring hiện có được thảo luận trong đó. Xác định các ví dụ sử dụng sample-data hoặc không tuân theo định dạng doctest kiểu NumPy đã nêu; được xem là hoàn thành khi các ví dụ được chọn hoạt động, tự chứa trong phạm vi có thể, sử dụng dữ liệu PhysioNet đã công bố khi phù hợp và tuân theo một phong cách nhất quán.

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

Mô tả

Pull request #433 brings to mind some things that could be improved in docstrings more generally. Cleaning these up might be a good starter issue.

  1. Obviously, code examples should be correct and actually work. :)

  2. Code examples should also be self-contained if possible, and avoid referring to files in sample-data (most people reading the documentation are probably not running the code directly from the git repository.) In most cases, it's better to use examples from published databases on PhysioNet.

  3. Code examples should be written in a consistent style. We generally use numpy style (https://numpydoc.readthedocs.io/en/latest/format.html) for docstrings, but we haven't been entirely consistent. In particular, numpy style requires examples to be written in "doctest" style, like this:

    """
    Examples
    --------
    >>> np.add([[1, 2], [3, 4]],
    ...        [[5, 6], [7, 8]])
    array([[ 6,  8],
           [10, 12]])
    """

This format has some nice properties (it can be tested automatically by doctest, and formatted nicely by sphinx.) On the other hand, the "..." is a little annoying when you want to copy and paste an example.

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

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

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 MIT-LCP/wfdb-python

Tất cả issue của MIT-LCP/wfdb-python

Issue tương tự

Thêm issue về Documentation

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.