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

Add cmap to animate_topomap #12418

Open
withmywoessner opened this issue Feb 5, 2024 · 3 comments
Open

Add cmap to animate_topomap #12418

withmywoessner opened this issue Feb 5, 2024 · 3 comments
Labels

Comments

@withmywoessner
Copy link
Contributor

Describe the new feature or enhancement

I would like to add a cmap parameter to animate_topomap. Currently, plot_topomap includes this parameter so I would like to update it to match plot_topomap.

Describe your proposed implementation

Add a new parameter cmap to animate_topomap

Describe possible alternatives

Maybe I can just add a tutorial to do this with existing matplotlib api??

Additional context

There may also be some other parameters I can add to bring the functionality closer to plot_topomap.

@larsoner
Copy link
Member

larsoner commented Feb 5, 2024

Yes feel free to add it. You can add just that or more params if you need to for your use case (or want to for completeness). I don't think animate_topomap has kept up with all options.

@withmywoessner
Copy link
Contributor Author

Is there some way I could accomplish this using **kwargs so it doesn't have to be updated each time something is added to animate_topomap? Thanks!

@larsoner
Copy link
Member

larsoner commented Feb 5, 2024

In principle yes (the syntax works) but in practice we avoid doing it because it can hide problems if you're not careful and forces people to look for docs elsewhere. Instead we prefer to duplicate and use docdict for the doc strings. It's more work for us as maintainers but nicer for users.

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

2 participants