-
Notifications
You must be signed in to change notification settings - Fork 4
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
Implement JOSS doc suggestions #101
base: main
Are you sure you want to change the base?
Conversation
…d added collapsible setup blocks
very nice & well done. These are the only two things I noticed |
Co-authored-by: Benedikt Ehinger <[email protected]>
Co-authored-by: Benedikt Ehinger <[email protected]>
Dear @roualdes, thanks again for your detailed list of suggestions. They were really helpful. We revised the documentation accordingly (see the description above). You can find a preview of the changes here: https://unfoldtoolbox.github.io/UnfoldSim.jl/previews/PR101/ Best, |
We implemented the doc suggestions from the JOSS review and fixed/modified some things on the way.
Changes related to the review:
Quickstart page: We added a short introduction about which ingredients are needed for a simulation. Hopefully, the given tip is more useful now given the context,
Simulate ERPs page: We added an introductory paragraph to explain the contexts of ERP components and give an example.
Poweranalysis page: We split "poweranalysis" in two words and matched sidebar and page title.
Reference Section:
API/DocStrings:
simulate()
docstring and the function such that it is recognized as a doc string.SingleSubjectDesign()
and theMultiSubjectDesign()
docstrings.predef_eeg()
doc string.RealisticNoise()
docstringExponentialNoise()
docstring.General changes
Additional changes: