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

Update liquid docs for named parameters #1831

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Conversation

graygilmore
Copy link
Contributor

@graygilmore graygilmore commented Oct 20, 2024

The YARD liquid gem now supports specifying named parameters. For the core liquid tags and filters this is the only object I could find that needed to be updated.

To specify a named parameter you need to add a : to the end of the name:

# @liquid_optional_param foo [string] This is a positional parameter
# @liquid_optional_param bar: [string] This is a named parameter

Adding a colon will make sure that the newly added positional attribute in the JSON docs will be set to false.

The YARD liquid gem now supports specifying named parameters. For the
core liquid tags and filters this is the only object I could find that
needed to be updated.
@graygilmore graygilmore marked this pull request as ready for review October 24, 2024 17:11
Copy link
Contributor

@charlespwd charlespwd left a comment

Choose a reason for hiding this comment

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

LGTM

@graygilmore graygilmore merged commit 6d58c41 into main Oct 28, 2024
11 checks passed
@graygilmore graygilmore deleted the gg-add-named-params-docs branch October 28, 2024 16:20
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.

2 participants