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 options documentation #537

Open
chrisn opened this issue Aug 15, 2024 · 0 comments
Open

Improve options documentation #537

chrisn opened this issue Aug 15, 2024 · 0 comments

Comments

@chrisn
Copy link
Member

chrisn commented Aug 15, 2024

Documentation of the Peaks.init() configuration options isn't easy to follow. We should think about how to present this in a way that's easier to understand, e.g., by describing groups of related options, providing examples, or structuring similar to the methods documentation.

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