docs: add particular use case to the modifiers docs #65
Conversation
This file contains 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
revolunet
reviewed
Jul 30, 2023
Signed-off-by: Fran Mulero <fmulero@vmware.com>
fmulero
approved these changes
Jul 31, 2023
There was a problem hiding this comment.
Thanks @kuisathaverat and @revolunet for your contribution. LGTM
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description of the change
It adds a particular case to the modifiers documentation I hit using custom modifiers.
The use case is when you do not give any value to the parameter and use a custom modifier.
Also, it adds the name of the parameter that hits the error when an error related to modifiers happens.
Benefits
Users will not spend time trying to resolve the issue, it is documented.
Possible drawbacks
none