mapbox / mapbox/mapbox-java

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

Offen
#1,450 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Directions Documentation jira-sync-complete
Vorherrschende Sprache
Java
Sterne
438
Forks
117
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Bearing-Eigenschaft und ihre Inline-Dokumentation im Java SDK zu finden. Aktualisiere die Beschreibung von degrees so, dass sie angibt, dass die akzeptierten Werte im Bereich von 0-180 liegen, und überprüfe anschließend, dass die Dokumentation dies klar vom Winkelbereich von 0-360 unterscheidet und korrekt in der IDE-Dokumentation angezeigt wird.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
1/5
Geschätzter Aufwand
Unter einer Stunde
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.