matplotlib / matplotlib/matplotlib
[Doc]: patches.FancyArrowPatch() and Donut demo: angleA and angleB not clearly defined
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 23.2k
- Fork
- 8.5k
- Merge trung bình
- 1 ngày 6 giờ
- Pull request đã merge (30 ngày)
- 66
Mô tả
### Documentation Link
https://matplotlib.org/stable/api/_as_gen/matplotlib.patches.FancyArrowPatch.html#matplotlib.patches.FancyArrowPatch
### Problem
The `FancyArrowPatch()` documentation does not adequately describe how _angleA_ and _angleB_ are defined, and the notes on those parameters in the regular `ArrowPatch()` documentation do not clearly translate to their usage in `FancyArrowPatch()`. This is a problem if, for example, one tries to use the [Donut chart labelling example](https://matplotlib.org/stable/gallery/pie_and_polar_charts/pie_and_donut_labels.html#sphx-glr-gallery-pie-and-polar-charts-pie-and-donut-labels-py) with data that results in 2 annotation boxes sitting on top of each other.
### Suggested improvement
Please add the following description, or something similar, to the `FancyArrowPatch()` documentation or the `annotate()` documentation where it describes _arrowprops_ kwargs:
>_angleA_ and _angleB_ are both measured counterclockwise from the positive x-axis, where the vertex referenced by _angleA_ is at the base of the arrow, and the vertex referenced by _angleB_ is at the head of the arrow.
It might also be good to include a similar description in the [donut example](https://matplotlib.org/stable/gallery/pie_and_polar_charts/pie_and_donut_labels.html#sphx-glr-gallery-pie-and-polar-charts-pie-and-donut-labels-py) to specify that the vertex of _angleA_ is where the arrow meets the textbox, and the vertex of _angleB_ is at the point that is being annotated.
Hướng dẫn đóng góp
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.
Hướng nghiên cứu
Bắt đầu với tài liệu API FancyArrowPatch được liên kết trong issue, sau đó xem lại ví dụ về nhãn biểu đồ tròn và biểu đồ donut. Làm rõ angleA và angleB được đo như thế nào và chúng tham chiếu đến các đỉnh nào; nếu phù hợp, hãy thêm cùng ngữ cảnh đó vào ví dụ donut. Công việc được xem là hoàn tất khi tài liệu loại bỏ sự mơ hồ được mô tả trong issue.
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
- data-visualization, documentation
- Loại issue
- Tài liệu
- Độ khó
- 2/5
- Thời gian dự kiến
- 1-3 giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Đặc tả rõ ràng
- Mức phù hợp với người mới
- 38/100