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

Complete the signature of plot methods with all their kind options #1479

Open
2 tasks
maximlt opened this issue Jan 27, 2025 · 0 comments
Open
2 tasks

Complete the signature of plot methods with all their kind options #1479

maximlt opened this issue Jan 27, 2025 · 0 comments
Assignees
Milestone

Comments

@maximlt
Copy link
Member

maximlt commented Jan 27, 2025

The converter class has a mapping from plot method name to options _kind_options.

class HoloViewsConverter:
    ...
    # Options specific to a particular plot type
    _kind_options = {
        ...
        'hexbin': ['C', 'reduce_function', 'gridsize', 'logz', 'min_count'],
        ...
    }

These options do not all appear in the signature of the plot method exposed to users, for instance, min_count for .hexbin().

class hvPlotTabular(hvPlotBase):
    ...
    def hexbin(self, x=None, y=None, C=None, colorbar=True, **kwds):
        ...

I'm not sure why some options aren't exposed in the signature, if there's one, I haven't found it yet.

Otherwise, I'd suggest adding:

  • making sure the options already defined in the signature are correctly documented in the docstring
  • add all the options not defined in the signature but in _kind_options to the signature.

In order to complete the second item, the default value of these options will have to be found and exposed. I assume they map to some HoloViews Parameter.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

2 participants