Skip to content

Minor refactor of code blocks in docs#362

Merged
mwtoews merged 1 commit intoToblerity:mainfrom
mwtoews:blacken-docs
Mar 31, 2025
Merged

Minor refactor of code blocks in docs#362
mwtoews merged 1 commit intoToblerity:mainfrom
mwtoews:blacken-docs

Conversation

@mwtoews
Copy link
Copy Markdown
Member

@mwtoews mwtoews commented Mar 29, 2025

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).

@mwtoews mwtoews added this to the 1.4.1 milestone Mar 29, 2025
@mwtoews
Copy link
Copy Markdown
Member Author

mwtoews commented Mar 29, 2025

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 *.py files).

@mwtoews mwtoews merged commit d623260 into Toblerity:main Mar 31, 2025
17 checks passed
@mwtoews mwtoews deleted the blacken-docs branch March 31, 2025 07:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants