Introductory documentation
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
- 25/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ệ
- rust
- Lĩnh vực
- documentation
Hướng nghiên cứu
Start by reviewing the existing reference documentation, the concerns in issues #160 and #327, and the ndarray for NumPy users guide cited in the issue. Done would be a separate high-level overview that explains ndarray's structure and design principles while gradually introducing the library to newcomers.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Mô tả
I was reasoning around this during the last few days while working on my PRs (and reading some issues like #160): it is really complicated to get a good overview of the way ndarray is structured solely relying on the reference documentation. It is even more complicated when the method you are looking at calls functions that are annotated with #[doc(hidden)] (it happens quite often in the core structs and traits implementations)
Without @jturner314's ndarray for NumPy users it would have taken me at least twice as long to reach my current level of understanding (which is still very partial). This echoes #327, for instance.
Would it be of interest to produce some kind of separate documentation, similar in spirit to http://nalgebra.org/ for nalgebra or http://scikit-learn.org/stable/ for scikit-learn?
A high-level overview of the overall crate, aimed at explaining the underlying design principles, gradually introducing a newcomer to the library.
I would be happy to work on it, at least to further my own understanding of ndarray.
What are your thoughts on the matter @bluss?
- Ngôn ngữ chính
- Rust
- Star
- 4.3k
- Fork
- 391
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
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
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Issue khác của rust-ndarray/ndarray
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
rust-ndarray/ndarray#1612 · 1 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
rust-ndarray/ndarray#1617 · 1 bình luận ·
-
Stack overflow in `triu` Đang mởbug good first issue
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 68/100
rust-ndarray/ndarray#1615 · 1 bình luận ·
-
Độ khó 4/5 3-5 ngày Mức phù hợp với người mới 48/100
rust-ndarray/ndarray#1610 ·
-
Độ khó 3/5 1-2 ngày Mức phù hợp với người mới 72/100
rust-ndarray/ndarray#1609 ·
Tất cả issue của rust-ndarray/ndarray
Issue tương tự
-
risk:low runtime status:in-progress type:test
Độ khó 1/5 Dưới một giờ Mức phù hợp với người mới 92/100
zeroclaw-labs/zeroclaw#11023 ·
-
good first issue refactor
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 72/100
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 84/100
EricSpencer00/Resilient#4835 · 1 bình luận ·
-
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 74/100
bisq-network/bisq-musig#204 ·
-
agent:ready documentation
Độ khó 2/5 1-3 giờ Mức phù hợp với người mới 88/100
cesarferreira/stax#890 ·