Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Make Specific Rules docstring more user friendly #2241

Merged
merged 1 commit into from Jan 6, 2022
Merged

Docs: Make Specific Rules docstring more user friendly #2241

merged 1 commit into from Jan 6, 2022

Conversation

jpy-git
Copy link
Contributor

@jpy-git jpy-git commented Jan 6, 2022

Brief summary of the change made

Follows on from discussion with @barrywhart here

Here's what the docs look like after updating the docstring:
image

Are there any other side effects of this change that we should be aware of?

No

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:

    • .yml rule test cases in test/fixtures/rules/std_rule_cases.
    • .sql/.yml parser test cases in test/fixtures/dialects (note YML files can be auto generated with tox -e generate-fixture-yml).
    • Full autofix test cases in test/fixtures/linter/autofix.
    • Other.
  • Added appropriate documentation for the change.

  • Created GitHub issues for any relevant followup/future enhancements if appropriate.

@barrywhart
Copy link
Member

Tests failing due to network issue -- will probably work on a rerun.

@codecov
Copy link

codecov bot commented Jan 6, 2022

Codecov Report

Merging #2241 (f1b7e9c) into main (91f8789) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main     #2241   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          156       156           
  Lines        11041     11041           
=========================================
  Hits         11041     11041           
Impacted Files Coverage Δ
src/sqlfluff/core/rules/__init__.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 91f8789...f1b7e9c. Read the comment docs.

@jpy-git
Copy link
Contributor Author

jpy-git commented Jan 6, 2022

Tests failing due to network issue -- will probably work on a rerun.

yeah a re-run sorted things, will merge now 😄

@jpy-git jpy-git merged commit aa9ac52 into sqlfluff:main Jan 6, 2022
@jpy-git jpy-git deleted the specific_rules_docstring branch January 6, 2022 12:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants