mapbox / mapbox/mapbox-java

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

オープン
#1,450 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

Directions Documentation jira-sync-complete
主要言語
Java
スター
438
フォーク
117
PR マージ指標
30日以内にマージされた PR はありません

説明

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).

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、Java SDK 内の Bearing プロパティとそのインラインドキュメントを見つけます。degrees の説明を更新して、受け入れられる値の範囲が 0-180 であることを記載し、その後、ドキュメントでこれが角度の範囲 0-360 と明確に区別され、IDE のドキュメントに正しく表示されることを確認します。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
java
領域
documentation
issue の種類
ドキュメント
難易度
1/5
見積もり時間
1時間未満
活発さ
停滞
明瞭さ
明確に書かれている
初心者へのやさしさ
55/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。