mapbox / mapbox/mapbox-java

Bearing property has input range for angle, but not for degrees.

Đang mở
#1,450 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.

Directions Documentation jira-sync-complete
Ngôn ngữ chính
Java
Star
438
Fork
117
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

The direction API accepts a list of tuples for the angle from true north, and degrees that we can deviate.

Directions API will accept 0-360 for the angle (including -0 interestingly enough) but will error outside of that range.

Directions API will accept 0-180 for the degrees and will error outside of that range.

In the inline documentation for Bearing we mention this 0-360 range of accepted values for angle but omit the 0-180 for degrees. We should update the 0-180 documentation so developers will see this in their IDE (and know not to pass degrees beyond 180).

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

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.

Hướng nghiên cứu

Bắt đầu bằng cách xác định thuộc tính Bearing và tài liệu inline của thuộc tính này trong Java SDK. Cập nhật mô tả của degrees để nêu rõ rằng các giá trị được chấp nhận nằm trong khoảng từ 0-180, sau đó xác minh rằng tài liệu phân biệt rõ điều này với khoảng góc 0-360 và hiển thị chính xác trong tài liệu IDE.

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

Đánh giá

Công nghệ
java
Lĩnh vực
documentation
Loại issue
Tài liệu
Độ khó
1/5
Thời gian dự kiến
Dưới một 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
55/100

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.