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

Tag optional filters in a parseable way #262

Closed
ml-evs opened this issue Mar 6, 2020 · 0 comments · Fixed by #263
Closed

Tag optional filters in a parseable way #262

ml-evs opened this issue Mar 6, 2020 · 0 comments · Fixed by #263
Labels
priority/low There is a consensus that this have low priority to sort out. status/has-concrete-suggestion This issue has one or more concrete suggestions spelled out that can be brought up for consensus.

Comments

@ml-evs
Copy link
Member

ml-evs commented Mar 6, 2020

We've already gone to some effort to make sure examples are tagged correctly as :filter:, which is really helpful. My suggestion is to also be clearer when marking optional features of the filter language. Currently we are very clear in the text, but it would be really helpful when generating examples for validation to either tag optional filters as e.g. :filter-optional, or to just ensure that lines that contain optional filter examples are prefixed with "OPTIONAL:" in the text, as we do in many places.

As a concrete example, HAS ONLY is introduced in the spec as:

The following construct MAY be supported:

- :filter:`list HAS ONLY values`: matches if all elements in :filter-fragment:`list` are equal to at least one :filter-fragment:`value`.

which could be reworded as:

The :filter-fragment:`HAS ONLY` construct MAY be supported:

- OPTIONAL: :filter:`list HAS ONLY values`: matches if all elements in :filter-fragment:`list` are equal to at least one :filter-fragment:`value`.
@ml-evs ml-evs added priority/low There is a consensus that this have low priority to sort out. status/has-concrete-suggestion This issue has one or more concrete suggestions spelled out that can be brought up for consensus. labels Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority/low There is a consensus that this have low priority to sort out. status/has-concrete-suggestion This issue has one or more concrete suggestions spelled out that can be brought up for consensus.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant