Format Markdown and Python code in docs #343
Open
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
* Format Python code within Markdown, via mdformat-ruff * Switch Python doctest code within Markdown (with leading `>>>`) to plain Python
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.
Changes
>>>) to plain PythonCommentary
I'm not positive I want this PR. The impact is pretty minor. I don't know if I want yet another tool to depend on. This came about while I was updating docs and noticing slight style inconsistencies. I stumbled across the tools and settings to remove the inconsistencies, and wanted to see what it'd be like, in this PR. 🤷♂️