mapbox / mapbox/mapbox-java

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

未关闭
#1,450 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

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. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先,在 Java SDK 中定位 Bearing 属性及其内联文档。更新 degrees 的描述,说明接受的值范围为 0-180,然后验证文档是否明确将其与 0-360 的角度范围区分开来,并且是否正确显示在 IDE 文档中。

由索引模型根据 Issue 内容生成。

评估

技术栈
java
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。