Improve api docs #207
Merged
Improve api docs #207
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
Remove internals, add fixate._switching + a few other tweaks
|
@josh-marshall-amp @jcollins1983 My primary aim was to get the new jig switching api documented before creating a new release. I hope to do that as soon as this is merged. I haven't been too pedantic, but quickly removed as much of the obviously non-public api details that were in the initial documentation build. I think overall it should make the docs much more usable |
|
for @jcollins1983 reference, the PRs get their auto-gen docs chucked up on readthedocs too. In this case it's the below, and you can always sub in the relevant PR |
josh-marshall-amp
approved these changes
Jul 31, 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.
Remove internals, add fixate._switching + a few other tweaks