Move to a consistent documentation of hyperparameters

YangLab-um / BiologicalOscillations.jl

A package for researchers working with biological oscillations

https://yanglab-um.github.io/BiologicalOscillations.jl/

MIT License

1 stars 2 forks source link

Move to a consistent documentation of hyperparameters #36

Closed ftavella closed 4 months ago

ftavella commented 5 months ago

Currently, we have two types of documentation on default_hyperparameters.jl. In DEFAULT_SIMULATION_OUTPUT we have the description of each parameter in the top docstring. For the rest, we have a comment after each variable definition. Check which one produces the correct output on the documentation and update everything to use only one style.