mapbox / mapbox/mapbox-java

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

Ouverte
#1,450 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Directions Documentation jira-sync-complete
Langage dominant
Java
Étoiles
438
Forks
117
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par localiser la propriété Bearing et sa documentation inline dans le Java SDK. Mettez à jour la description de degrees pour indiquer que les valeurs acceptées vont de 0-180, puis vérifiez que la documentation distingue clairement cette plage de la plage d’angles de 0-360 et qu’elle apparaît correctement dans la documentation de l’IDE.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
documentation
Type d'issue
Documentation
Difficulté
1/5
Temps estimé
Moins d'une heure
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
55/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.