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

Improve documentation on Component and Media #321

Open
Jean1995 opened this issue Oct 4, 2022 · 0 comments
Open

Improve documentation on Component and Media #321

Jean1995 opened this issue Oct 4, 2022 · 0 comments

Comments

@Jean1995
Copy link
Member

Jean1995 commented Oct 4, 2022

There should be a jupyter notebook which describes how to use custom components and media, and which describes how they work in general.

Furthermore, we should revise the in-code documentation of these classes as well (both variable names and docstrings). Most descriptions have just been carried over from MMC, and I believe that some translations are wrong (or at the very least misleading).

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

No branches or pull requests

1 participant