Documentation mismatch re: polar + bargap

[lswainemoore]

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:

• plotly.js/src/traces/barpolar/calc.js

  Line 95 in 9010f78

  gap: polarLayout.bargap,

• plotly.js/src/traces/barpolar/layout_attributes.js

  Line 17 in 9010f78

  bargap: {

• plotly.js/test/image/mocks/polar_wind-rose.json

  Line 38 in 9010f78

  "bargap": 0,

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.

[lswainemoore]

By the way, this issue seems related: #3023, but it looks like the fix maybe didn't get far enough? Not honestly sure.

[lswainemoore]

I guess there is this:

plotly.js/src/traces/barpolar/layout_attributes.js

Line 14 in 9010f78

'you might need to reduce *opacity* to see multiple bars.'

, which seems to manifest a separate entry in here, though not in the polar layout section. I have to say I am now quite confused about what the intentions are here--any help with the relationship between all these files would be appreciated!