Add inline_comment_spaces formatter option - #883
Open
ChrisJr404 wants to merge 1 commit into
Open
Conversation
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
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.
Closes #469.
Adds an
inline_comment_spacesformatter option to control how many spaces go before a trailing comment on the same line as an entry or array item, similar to PEP 8's two-space convention. It defaults to 1, so existing output is unchanged, and it only kicks in when the comment isn't being aligned byalign_comments(the alignment logic already handles spacing in that case).The spacing is applied in
format_rowsby overriding the separator used before the comment column, so it covers both entry comments and array item comments. Added two formatter tests (one for the new spacing, one asserting the default stays a single space) and a row in the formatter options docs.