Remove the behavior of removing the double line breaks in python files #12
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
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.
I see the benefits of removing double line breaks in the docstrings, but this has caused a bunch of pain getting ruff and black to both format and check without errors, @adriangb and I both feel this would make things simpler enough to be worth the change.
In particular, right now in pydantic if you run the formatting code, you get double line breaks that need to be removed, but I struggled to make it work where it would remove those and also not fail black/ruff checks.
Definitely open to a fix on the pydantic side, I just don't know that it's worth the brain power given the only benefit is removing (currently in pydantic) a single newline from one docstring each in three files.
If there was broader usage of this library I'd be more concerned but my understanding is that we are probably the only ones using it very deeply for this purpose, and I suspect no one would mind the change.