altair icon indicating copy to clipboard operation
altair copied to clipboard

Ensure most Chart methods link to the appropriate class

Open multimeric opened this issue 3 years ago • 3 comments

Closes #2608.

This renders like this:

Before: image

After: image

Note that these are now hyperlinks.

multimeric avatar Jun 02 '22 04:06 multimeric

Thank you @multimeric ! This seems like a good way of dealing with the issue you raised. I am going to try it out locally after some of the other doc PRs have been merged (e.g. #2566 )

joelostblom avatar Jun 07 '22 14:06 joelostblom

I've now done the same for the transform_* and mark_* methods.

Before: image image

After: image image

multimeric avatar Jun 09 '22 04:06 multimeric

Nice! I agree that this addition makes the docs more friendly to use. @jakevdp Should new changes like these changes only be made to the v5 schema or also "backported" to v4 and v3 as in the PR currently?

joelostblom avatar Jun 09 '22 14:06 joelostblom

I favor not doing the backport.

mattijn avatar Nov 17 '22 20:11 mattijn

Me too so let's go with that. @multimeric sorry for the delay here. Could you remove the v3 and v4 versions of mixins.py from this PR? I am also not sure about the changes to API.rst, but maybe that's because we're out of sync with master, could you rebase and double check API.rst manually?

joelostblom avatar Nov 27 '22 02:11 joelostblom

@binste, could you please check if this PR is still of interest?

mattijn avatar Feb 19 '23 17:02 mattijn

Changes look great and relevant, I think it's a good improvement to the docs. Could you merge in master and run python tools/generate_schema_wrapper.py again and then ping me? I could then build the docs locally and see if the changes still render fine, which they should.

binste avatar Feb 19 '23 19:02 binste

There are currently numerous conflicts that need resolving first. I can have a look later this week.

mattijn avatar Feb 19 '23 19:02 mattijn