Rules documentation improvements #2542
Merged
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
tunetheweb
commented
Feb 2, 2022
Codecov Report
@@ Coverage Diff @@
## main #2542 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 163 163
Lines 11771 11781 +10
=========================================
+ Hits 11771 11781 +10
Continue to review full report at Codecov.
|
tunetheweb
commented
Feb 2, 2022
barrywhart
requested changes
Feb 2, 2022
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
Co-authored-by: Barry Hart <barrywhart@yahoo.com>
|
Thanks for the very thorough review @barrywhart ! Think I've addressed all the comments. |
barrywhart
approved these changes
Feb 2, 2022
|
@barrywhart I added some more changes for your old issue as noted here: #812 (comment) Mind giving those changes a quick once over in case of typos or difficult to understand phrasing? |
|
Ok gave this another read over and am happy with it. Gonna merge as quite a big PR so don’t like leaving those open for merge conflict hell. |
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
Fixes #2544
Fixes #812
as well as making a host of other changes.
I noticed a couple of things that bugged me with the rules documentation page, and ended up going down the rabbit hole and fixing loads of things. None of them are major, but they bug me!
I have also added a new test to check the
@document_configurationdecorator is added when there are config options because it was missing in a lot of cases.Examples of some things I have fixed in this:
Rule L001:
Issues:
•is not code formatted.sqlfluff fixcompatible" line looks a bit odd starting with codeNew version:
Rule L004
Issues:
New version:
Rule L007
Issues:
New version:
Rule L009:
Issues - scrolling in code block
New version:
Are there any other side effects of this change that we should be aware of?
Nope, but lots of changes here!
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/dialects(note YML files can be auto generated withtox -e generate-fixture-yml).test/fixtures/linter/autofix.Added appropriate documentation for the change.
Created GitHub issues for any relevant followup/future enhancements if appropriate.