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

[Doc]: Tutorial how to write custom wrapper functions #28248

Open
timhoffm opened this issue May 17, 2024 · 2 comments
Open

[Doc]: Tutorial how to write custom wrapper functions #28248

timhoffm opened this issue May 17, 2024 · 2 comments

Comments

@timhoffm
Copy link
Member

Documentation Link

No response

Problem

We explicitly encourage the pattern to write custom helper functions for special plots. We also have some examples like https://matplotlib.org/stable/gallery/lines_bars_and_markers/horizontal_barchart_distribution.html. But we don't have a general description how to best design such functions.

Suggested improvement

Add a tutorial/explantion to our docs. Something similar to the section "Write your own wrapper function" at https://github.com/timhoffm/using-matplotlib/blob/main/05_Libraries_using_Matplotlib.ipynb

@jklymak
Copy link
Member

jklymak commented May 17, 2024

Note that we do have https://matplotlib.org/stable/users/explain/quick_start.html#making-a-helper-functions. Perhaps not in the best of spots.

@tacaswell
Copy link
Member

I would also add https://github.com/tacaswell/2021-03_APS/tree/main/code/harmonic_oscilator as a source of material.

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

3 participants