Fix "sqlfluff fix compatible" rules indenting to much in documentation #1405
+2
−2
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
Codecov Report
@@ Coverage Diff @@
## main #1405 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 127 127
Lines 8450 8553 +103
==========================================
+ Hits 8450 8553 +103
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
barrywhart
approved these changes
Sep 14, 2021
Not any more you don't! Merge #1404 and you wont see these each time! 😀 |
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.
Brief summary of the change made
Noticed in our Rules documentation that when
sqlfluff fix compatibleis added, it causes the rest of the documentation to indent:This means the
sqlfluff fix compatiblerules are out of alignment with the non-sqlfluff fix compatiblerules.Turns out to be because there it is straight inserted with no indents so looks like the start of a new section.
Are there any other side effects of this change that we should be aware of?
Don't think so.
Pull Request checklist
Please confirm you have completed any of the necessary steps below.
Included test cases to demonstrate any code changes, which may be one or more of the following:
.ymlrule test cases intest/fixtures/rules/std_rule_cases..sql/.ymlparser test cases intest/fixtures/parser(note YML files can be auto generated withpython test/generate_parse_fixture_yml.pyor by runningtoxlocally).test/fixtures/linter/autofix.Added appropriate documentation for the change.
Created GitHub issues for any relevant followup/future enhancements if appropriate.