DOC: Make explanation image for Reprs

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

Maintainer thường phản hồi trong vòng 1 ngày

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
30/100
Loại issue
Tài liệu
Độ 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

Issue không nêu tệp đích hoặc bài kiểm thử nào; hãy bắt đầu bằng cách xem xét các repr được in ra và HTML của xarray, cùng các câu hỏi được liệt kê về tọa độ in đậm, tên trong ngoặc đơn, tọa độ 2D và các chiều của dataset. Hoàn tất nghĩa là tạo ra một hình ảnh giải thích rõ ràng có chú thích và xác định nơi nên thêm hình ảnh đó vào tài liệu.

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

Mô tả

topic-documentation topic-html-repr
What is your issue?

I was helping someone learn to use xarray and they expressed some confusion for understanding the xarray repr (both html and print). They raise good points about the discoverability of what things mean.

i.e.

  • what is a bolded coord?
  • what are the names in parens
  • thrown off by 2d coords looking like they are 1d in the repr
  • confusion on what a dimension is on a dataset. not necessarily jus thte dimensions of the data

I think these confusions could be solved with a well made image with annotations on top of an image of the repr. Similar to this anatomy of a figure from matplotlib:

Image

or this legend guide:

Image (from the amazing: https://stackoverflow.com/a/43439132)
Ngôn ngữ chính
Python
Star
4.2k
Fork
1.5k
Merge trung bình
2 ngày 21 giờ
Pull request đã merge (30 ngày)
74

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 pydata/xarray

Tất cả issue của pydata/xarray

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.