ruff_python_formatter: move docstring handling to a submodule#8861
Merged
BurntSushi merged 2 commits intomainfrom Nov 27, 2023
Merged
ruff_python_formatter: move docstring handling to a submodule#8861BurntSushi merged 2 commits intomainfrom
BurntSushi merged 2 commits intomainfrom
Conversation
This will let us add sub-modules. In particular, the docstring handling is getting big enough to be worth splitting into its own module for room to breath.
Contributor
|
charliermarsh
approved these changes
Nov 27, 2023
Member
charliermarsh
left a comment
There was a problem hiding this comment.
Great, thanks for following up!
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
2 participants
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 turns
stringinto a parent module with adocstringsub-module. I arranged things this way because there are parts of thestringmodule that thedocstringmodule wants to know about (such as aNormalizedString). The alternative I think would be to makedocstringa sibling module and expose more ofstring's internals.I think I overall like this change because it gives docstring handling a bit more room to breath. It has grown quite a bit with the addition of code snippet formatting.
This was suggested by @charliermarsh.