Documentation mismatch re: polar + bargap
@LiamConnors 已经在做这个了。
开始于 2025年2月3日。
评估
这个 Issue 还没有评估数据。
描述
Hi--I'm not sure how exactly this works, but I believe the layout documentation for polar traces doesn't match the behavior in the code. In particular, the bargap property seems to be missing.
For a barpolar type plot, I can verify that it works when nested within the polar key of the layout object, but not when at the parent layout level (as the documentation seems to imply: https://plotly.com/javascript/reference/layout/.
Although most of the inner workings are beyond me, behavior (not documentation) seems consistent with bits of code like:
- https://github.com/plotly/plotly.js/blob/9010f78dde49fef6b6d27e49e03247f825b2ea24/src/traces/barpolar/calc.js#L95
- https://github.com/plotly/plotly.js/blob/9010f78dde49fef6b6d27e49e03247f825b2ea24/src/traces/barpolar/layout_attributes.js#L17
- https://github.com/plotly/plotly.js/blob/9010f78dde49fef6b6d27e49e03247f825b2ea24/test/image/mocks/polar_wind-rose.json#L38
All this leads me to believe that the documentation is wrong, or rather that whatever schema (I'm guessing this?) is informing the documentation is wrong. Of course, I wouldn't be too bothered by this, except that I assume the same schema that generates the documentation also informs the types here, which are also missing bargap, and is giving typescript grief. I know (think?) the types are not plotly's responsibility, but I think fixing the schema here would help downstream.
Thanks, and I appreciate your work.
- 主要语言
- JavaScript
- 星标
- 18.3k
- 派生
- 2k
- 平均合并
- 2 天 10 小时
- 30 天内合并 PR
- 30
贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
plotly/plotly.js 的其他 Issue
-
chore P3 plotly-internal size: 3 task
难度 2/5 1-3 小时 新手友好度 77/100
-
bug P2 size: 1
难度 2/5 1-3 小时 新手友好度 72/100
-
chore P1 plotly-internal size: 1 task
难度 1/5 1 小时以内 新手友好度 82/100
-
chore P3 plotly-internal size: 1 task
难度 2/5 1-3 小时 新手友好度 65/100
-
bug
难度 2/5 1-3 小时 新手友好度 65/100
相似的 Issue
-
bug customer-eng Durable Agents Inngest status: needs triage
难度 2/5 1-3 小时 新手友好度 82/100
-
optimization optimization:agents-md-curator
难度 2/5 1-3 小时 新手友好度 75/100
githubnext/gh-aw-cao#13475 ·
-
[BUG]: "Clear All" in Settings doesn't clear the saved analysis, old data comes back after reload 未关闭bug
难度 2/5 1-3 小时 新手友好度 88/100
AOSSIE-Org/OrgExplorer#253 · 1 条评论 ·
-
难度 2/5 1-3 小时 新手友好度 88/100
oxc-project/oxc#26944 ·
-
ai-observability bug team/ai-observability
难度 2/5 1-3 小时 新手友好度 78/100