Minor refactor of code blocks in docs#362
Merged
mwtoews merged 1 commit intoToblerity:mainfrom Mar 31, 2025
Merged
Conversation
Member
Author
|
This effort does not attempt to refactor the module docs or examples. I'll consider re-writing the docs using a numpy-style for 1.5, which may also update some of these examples (blacken docs doesn't work on examples in |
adamjstewart
approved these changes
Mar 29, 2025
This file contains hidden or 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
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.
This is a relatively minor refactor of the code blocks in the docs. Mostly to update the look-and-feel via blacken-docs (not added as a check or pre-commit), but also to check that they are running as expected, now checked in unit tests.
There were some Python 2 left-overs updated for Python 3. Also, temporary directories are used for the disk serialization examples, so they don't pollute the current working directories (and these tests break when run more than once due to the append mode).