Add documentation about AndCondtion and OrCondition filters#441
Merged
alexander-schranz merged 1 commit intoPHP-CMSIG:0.6from Oct 10, 2024
Merged
Conversation
b0d4dea to
62cb1c4
Compare
62cb1c4 to
8a08f60
Compare
ToshY
reviewed
Oct 10, 2024
| ~~~~~~~~~~~~ | ||
|
|
||
| The ``AndCondition`` is used to combine two or multiple conditions where all conditions need to match. | ||
| As by default all conditions are ``AND``` connected it only make sense to use ``AndCondition`` in |
Contributor
There was a problem hiding this comment.
Think the textual explanation can be improved a bit:
- There's a trailing backtick too much in ``AND```.
- Think grammatically the second sentence is a bit off:
- I'm reading the text "As by default all conditions are ``AND``` connected it only make sense..." as one single sentence, even though I think there's supposed to be a comma here (after "connected").
- Think "...it only makes sense" is correct (the additional s).
- Think you can omit "an" (singular) in "...with an
OrConditionfilters.". Thus "...withOrConditionfilters." seems better.
Overall, I would rephrase the second sentence more like this:
By default, all conditions are connected with
AND, so it only makes sense to use anAndConditionin combination withOrConditionfilters.
It seems very (very) nitpicky to be honest, and while I'm willing to create a PR for it, I'm not sure if it's of any worth. Maybe next time the docs are updated this can be updated as well. It's totally up to you 🙂
Overall the examples are clear and that's what matters.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This add missing docs about the newly added
AndConditionandOrConditionfrom #433 .fix #317