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

doc: Directly link to API in docs, remove repetitions #90

Merged
merged 4 commits into from
May 3, 2024

Conversation

eddiebergman
Copy link
Contributor

@eddiebergman eddiebergman commented May 3, 2024

This PR mainly cleans up the search space and analyses doc pages by linking directly to the code docstrings (API) doc but also re-organizing things slightly to favour simpler concepts first.

  • Search Space: Introduce parameters first before all the ways you can define and pass them in
  • Analysis: Give short intro to python -m status and python -m plot first before introducing tblogger. Show example usage of function in the docs.

@eddiebergman eddiebergman added the documentation Improvements or additions to documentation label May 3, 2024
@eddiebergman eddiebergman self-assigned this May 3, 2024
@eddiebergman eddiebergman changed the title doc: Directly link to API docs in search_space docs doc: Directly link to API in docs, remove repetitions May 3, 2024
@eddiebergman eddiebergman merged commit b3e76a8 into master May 3, 2024
12 checks passed
@eddiebergman eddiebergman deleted the doc-reference-function-doc-directly branch May 3, 2024 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extract documentation from docstrings for better maintenance
1 participant