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.

Sign up for GitHub

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

Jump to bottom

Document new MixingParameter presets #276

Open
3 tasks
JostMigenda opened this issue Oct 6, 2023 · 0 comments
Open
3 tasks

Document new MixingParameter presets #276

JostMigenda opened this issue Oct 6, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@JostMigenda
Copy link
Member

While we have mixing parameter presets since #198, these don’t have a docstring and thus aren’t documented yet. We should

  • add a docstring for the MixingParameters function, which lists the available presets
  • recommend these presets in the module-level docstring (but note that manually defining parameters via the MixingParameters{3,4}Flavor is available for advanced usage)
  • include usage examples in Jupyter notebooks that demo flavour transformations

Though it may be better to wait a bit with that last point, in case there are API changes as we implement the earth matter effect and stacked flavour transformations?
@JostMigenda JostMigenda added the documentation Improvements or additions to documentation label Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@JostMigenda