Documentation mismatch re: polar + bargap
@LiamConnors arbeitet bereits daran.
Seit 03.2.2025.
Bewertung
Dieses Issue wurde noch nicht bewertet.
Beschreibung
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.
- Vorherrschende Sprache
- JavaScript
- Sterne
- 18.3k
- Forks
- 2k
- Ø Merge
- 2 T. 17 Std.
- Gemergte PRs (30 T.)
- 22
Beitragsleitfaden
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus plotly/plotly.js
-
bug
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
-
chore P3 plotly-internal size: 3 task
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 77/100
-
chore P1 plotly-internal size: 1 task
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 82/100
-
chore P3 plotly-internal size: 1 task
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
-
bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 65/100
Alle Issues in plotly/plotly.js
Ähnliche Issues
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 82/100
-
area-deployment area-integrations triage:bot-seen
Schwierigkeit 2/5 Ein halber Tag Anfängerfreundlichkeit 86/100
-
Issue-Bug
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 68/100
sugarlabs/musicblocks#8924 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
ArduPilot/ardupilot_wiki#8088 ·
-
[BUG] createTool tools cannot be registered with Mastra when exactOptionalPropertyTypes is enabled Offencustomer-eng status: needs triage
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 84/100