More documentation updates #887
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
3 tasks
bpkroth
commented
Dec 5, 2024
bpkroth
commented
Dec 5, 2024
bpkroth
commented
Dec 5, 2024
bpkroth
commented
Dec 5, 2024
bpkroth
commented
Dec 5, 2024
10 tasks
bpkroth
added
documentation
motus
approved these changes
Dec 5, 2024
bpkroth
added a commit
that referenced
this pull request
Dec 6, 2024
…for tunables (#890) # Pull Request ## Title Allow loading configs from JSON strings not just files and add docs for Tunables to demonstrate and test it. --- ## Description Adds basic support for loading a JSON config string directly. The main purpose is to be able to show examples in docstrings that are testable (so that they don't become stale examples). - [x] Add basic example of usage and testing in a tunables docstring example. - [x] Add `pytest` unit tests for config string loading as well (we already have file loading tests). - Closes #881 --- ## Type of Change - ✨ New feature - 📝 Documentation update - 🧪 Tests --- ## Testing - [x] Adds additional unit tests. --- ## Additional Notes (optional) Split out from #887 ---
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.
Pull Request
Title
More documentation updates
Description
Type of Change
Additional Notes (optional)
Follow on to #869