Improve docstring and typehint of dims/axis Simplex

Đã đóng Phù hợp với người mới
#280 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.

Đánh giá

Độ khó
1/5
Thời gian dự kiến
Dưới một giờ
Mức phù hợp với người mới
62/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
python
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu từ toán tử proximal của Simplex và các tham số dims/axis của nó. Cần thay đổi docstring và type hint của các đối số này. Đọc docstring của lớp Simplex để xem hiện nó nói gì về dims và axis, sau đó kiểm tra xem type hint trong chữ ký có khớp với ràng buộc 2 chiều và axis chỉ bằng 0 hoặc 1 hay không. Hoàn thành khi docstring nêu rõ dims phải là 2D và axis chỉ có thể là 0 hoặc 1, đồng thời type hint phản ánh điều đó.

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

Mô tả

documentation

The docstring of Simplex currently does not clarify the fact that dims can only be 2dimensional and therefore axis can only be 0 or 1 (currently set as -1 = 1).

Clarify this.

Ngôn ngữ chính
Python
Star
85
Fork
22
Merge trung bình
10 giờ 53 phút
Pull request đã merge (30 ngày)
1

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

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 PyLops/pyproximal

Tất cả issue của PyLops/pyproximal

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.