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

Improve readability of DEHB examples and docstrings #10

Open
Neeratyoy opened this issue Oct 19, 2021 · 1 comment
Open

Improve readability of DEHB examples and docstrings #10

Neeratyoy opened this issue Oct 19, 2021 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@Neeratyoy
Copy link
Collaborator

It will be useful to have more elaborate filler text in the notebooks serving as examples for using DEHB.

Also, it will be useful to have more docstrings that help explain DEHB function arguments. The example notebooks should also highlight how information on the arguments can be retrieved, for example as ?dehb.run.
@Neeratyoy Neeratyoy added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 19, 2021
@Neeratyoy
Copy link
Collaborator Author

PRs are welcomed!

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 enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Neeratyoy