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

MarkDef docs contains composite marks in docstring #9290

Open
joelostblom opened this issue Mar 17, 2024 · 0 comments
Open

MarkDef docs contains composite marks in docstring #9290

joelostblom opened this issue Mar 17, 2024 · 0 comments
Labels

Comments

@joelostblom
Copy link
Contributor

Follow up on vega/altair#3370.

In VL there is a single generic docstring for mark definitions that is used for both MarkDef and CompositeMarkDef. This means that the docs on MarkDef show that it takes the composite mark strings 'boxplot" etc as arguments, but this is not correct. It would be helpful if the docstring could be modified so that MarkDef show only plain marks and CompositeMarkDef show only composite marks.

If this is as simple as deleting the docstring from the generic ref and creating two new separate ones in the two places I linked above, then I'm happy to create the PR.

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

No branches or pull requests

1 participant