experiment.parameters: Build API docs #420
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
dnadlinger
commented
Nov 28, 2024
dnadlinger
commented
- parameters: Remove unused ParamHandle._change_cb()
- experiment.parameters: Show in API docs, add minimal doc stubs
- experiment.parameters: Make [un]register_handle() underscore-private
The docstrings still need considerable work, but this is a start.
They are tightly-coupled to the ParamHandle implementation, and shouldn't ever be called directly. This could use some refactoring altogether as the ARTIQ compiler gets less and less buggy/limited.
Merged
via the queue into
OxfordIonTrapGroup:master
with commit Nov 28, 2024
83cc812
4 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.