Bearing property has input range for angle, but not for degrees.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 438
- Forks
- 117
- PR merge metrics
- No merged PRs in 30d
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).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Bearing property and its inline documentation in the Java SDK. Update the degrees description to state that accepted values range from 0-180, then verify that the documentation clearly distinguishes this from the angle range of 0-360 and appears correctly in IDE documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100