De-indent docstrings code examples#93
Merged
Merged
Conversation
Necessary for proper formatting in Zensical docs...for now..
2 tasks
This is a strange section, which amounts to "Don't use this!" None of the code examples actually pertain to usage OF THIS MODULE :) Let's just get rid of it then?
Not sure how I missed it before
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
1 participant
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.
I asked the LLM to de-indent all code examples within docstrings, as it's necessary for proper formatting (right now) in Zensical docs...mkdocstrings/griffe#465 could fix things long-term if we find that necessary
Note that I chose this over
```pythoncode blocks so they're still caught by doctests.Closes #89