Update documentation #103
Merged
Update documentation #103
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
stefsmeets
approved these changes
Nov 19, 2024
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.
Fix #100
Update documentation to reflect changes in #99
The mkdocs build seems correct locally.
Also adds an ignore filter to the nbcheckorder pre-commit for the single unexecuted notebook, but we could instead use the new
--allow-unexecuted-notebooksflag now if we update to v0.3I considered adding type hints to
ctrlin functions, but importing theTEMControlleralso performs config setup since config is also imported. While this would probably be done regardless when using the functions taking aTEMControlleras input, it can be done later.