Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extra backtick in LegendConfig.labelOverlap doc #9524

Open
1 task done
dangotbanned opened this issue Feb 3, 2025 · 2 comments
Open
1 task done

Extra backtick in LegendConfig.labelOverlap doc #9524

dangotbanned opened this issue Feb 3, 2025 · 2 comments

Comments

@dangotbanned
Copy link
Member

Bug Description

I've finally traced this back to a typo as causing some strange parsing in the docs for both vega-lite and altair

* __Default value:__ `"greedy"` for `log scales otherwise `true`.

vega-lite

Image

altair

docstring of altair.vegalite.v5.schema.core.LegendConfig:169: WARNING: Inline literal start-string without end-string. [docutils]
docstring of altair.vegalite.v5.schema._config.LegendConfigKwds:169: WARNING: Inline literal start-string without end-string. [docutils]

Image

Fix

I think the fix is to go from:

 * __Default value:__ `"greedy"` for `log scales otherwise `true`. 

to:

 * __Default value:__ `"greedy"` for log scales otherwise `true`. 

Checklist

  • I checked for duplicate issues.
@dangotbanned dangotbanned changed the title Extra "" in LegendConfig.labelOverlap` doc Extra `` in LegendConfig.labelOverlap` doc Feb 3, 2025
@dangotbanned dangotbanned changed the title Extra `` in LegendConfig.labelOverlap` doc Extra \ in LegendConfig.labelOverlap` doc Feb 3, 2025
@dangotbanned dangotbanned changed the title Extra \ in LegendConfig.labelOverlap` doc Extra "\" in LegendConfig.labelOverlap` doc Feb 3, 2025
@dangotbanned dangotbanned changed the title Extra "\" in LegendConfig.labelOverlap` doc Extra char in LegendConfig.labelOverlap doc Feb 3, 2025
@dangotbanned dangotbanned changed the title Extra char in LegendConfig.labelOverlap doc Extra backtick in LegendConfig.labelOverlap doc Feb 3, 2025
@domoritz
Copy link
Member

domoritz commented Feb 3, 2025

Good catch. Are you sending a PR or want me to fix it?

@dangotbanned
Copy link
Member Author

dangotbanned commented Feb 3, 2025

Good catch. Are you sending a PR or want me to fix it?

@domoritz I'm working on some related bits in altair right now, if you could fix here that'd be perfect 🤝

Note

This issue was the only one I found that seemed to affect both projects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants