Documentation mismatch re: polar + bargap
@LiamConnors がすでに取り組んでいます。
2025年2月3日 から。
- 主要言語
- JavaScript
- スター
- 18.3k
- フォーク
- 2k
- 平均マージ
- 2日 12時間
- マージ済み PR(30日)
- 28
説明
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.
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
評価
この issue はまだ評価されていません。