Documentation mismatch re: polar + bargap
@LiamConnors ya está trabajando en esto.
Desde el 3/2/2025.
- Lenguaje dominante
- JavaScript
- Estrellas
- 18.3k
- Forks
- 2k
- Merge medio
- 2 d 12 h
- PR fusionados (30 d)
- 28
Descripción
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.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Evaluación
Este issue todavía no se ha evaluado.