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

Fix issues with placeholder templating docs #2078

Merged
merged 2 commits into from Dec 9, 2021
Merged

Fix issues with placeholder templating docs #2078

merged 2 commits into from Dec 9, 2021

Conversation

jpy-git
Copy link
Contributor

@jpy-git jpy-git commented Dec 9, 2021

Brief summary of the change made

Fixes #1996.
This PR clarifies the placeholder templating documentation.

  1. Fixes docs referring to the wrong config section. Should refer to [sqlfluff:templater:placeholder]
  2. Adds note on using quotes around custom param_regex.
  3. Adds an example for using positional param style.
  4. Adds note on enabling placeholder templating.

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

No, fixes docs to match code

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 python test/generate_parse_fixture_yml.py or by running tox locally).
    • 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.

@jpy-git
Copy link
Contributor Author

jpy-git commented Dec 9, 2021

@barrywhart @tunetheweb

Copy link
Member

@tunetheweb tunetheweb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM though can't say I know the placeholder templater, but am assume you do :-)

@jpy-git jpy-git merged commit d8adba3 into sqlfluff:main Dec 9, 2021
@jpy-git jpy-git deleted the fix_placeholder_docs branch December 9, 2021 14:46
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.

Placeholder-templating documentation: incorrect example with config group name and param_regex
2 participants