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 API (function) docs #2530

Open
ewels opened this issue May 3, 2024 · 0 comments
Open

Add API (function) docs #2530

ewels opened this issue May 3, 2024 · 0 comments
Milestone

Comments

@ewels
Copy link
Member

ewels commented May 3, 2024

Now that we're opening up MultiQC internals for use in scripts (#2442), we should document how to use them.

We can write prose documentation in docs, but we should also use standardised docstring documentation. This will be easier to keep up to date and in sync and can be used as reference docs.

See also #2008

@ewels ewels added this to the MultiQC v1.23 milestone May 3, 2024
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