Add Input documentation for exact_match
#51064
Merged
+10
−0
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
raulsntos
force-pushed
the
doc-input-exact_match
branch
from
9f8304d
to
b64c2c7
Compare
akien-mga
reviewed
Jul 30, 2021
doc/classes/Input.xml
Outdated
| @@ -60,6 +60,7 @@ | |||
| <argument index="0" name="action" type="StringName"> | |||
| </argument> | |||
| <argument index="1" name="exact_match" type="bool" default="false"> | |||
| If [code]true[/code] the event that contributes to the raw strength only matches the action if the event provided exactly matches the action event. For an action like [code]KEY_S[/code], the event [code]KEY_CONTROL + KEY_S[/code] matches if [code]exact_match[/code] is [code]false[/code] but not if it is [code]true[/code]. | |||
There was a problem hiding this comment.
You can't add documentation for arguments this way, it should be part of the <description>.
E.g. If [code]exact_match[/code] is [code]true[/code], ....
There was a problem hiding this comment.
So should I move the text to inside the <description> tag and leave the <argument> tag empty?
There was a problem hiding this comment.
Yes, argument tags don't support text.
raulsntos
force-pushed
the
doc-input-exact_match
branch
from
b64c2c7
to
55206ec
Compare
akien-mga
approved these changes
Jul 30, 2021
|
Thanks! |
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.
Adds documentation for PR #44355