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

Minimal working code examples for experiments API docs #1221

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

coruscating
Copy link
Collaborator

@coruscating coruscating commented Jul 10, 2023

Summary

As a response to user feedback that it would be useful to have a code snippet to copy for each experiment, this PR adds minimal working examples to the API pages for each experiment. This uses the Example section which already exists and hides the test backend setup in a :hide-code: block. Since the code block is meant to work when copied directly, it should have all the imports needed for the experiment itself (except for the backend, which we assume the user will provide).

@coruscating
Copy link
Collaborator Author

T1 looks like this:
image

@CLAassistant
Copy link

CLAassistant commented Jul 18, 2023

CLA assistant check
All committers have signed the CLA.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants