DOCS: DOCATT Quality Sprint batch fixes #2240
Open
+28
−8
Conversation
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
- Added doc for JoinPlayersWhenJoinActionIsTriggered value - Clarified that disabling the action can result when DisableJoining() is called on an action that was joined with the JoinPlayersWhenJoinActionIsTriggered behaviour
Pauliusd01
reviewed
Sep 19, 2025
| /// Note that when setting sampling frequencies, there may be limits on the range of frequencies | ||
| /// supported by the underlying hardware/platform. | ||
| /// | ||
| /// To support querying sampling frequencies, a sensor device must implement <see cref="QuerySamplingFrequencyCommand"/>. |
There was a problem hiding this comment.
Why is this line removed?
There was a problem hiding this comment.
I removed that line because we don't document that command because it's internal. Users get frustrated when we recommend using something but they can't find it. I confirmed with @ritamerkl that it was ok to remove that line in a Slack thread on the input-team channel.
Pauliusd01
reviewed
Sep 19, 2025
| /// Inhibit players from joining the game. | ||
| /// </summary> | ||
| /// <remarks> | ||
| /// Note that this method might disable the action, depending on how the action |
There was a problem hiding this comment.
I assume this meant to say "depending on how the player joined..." instead
There was a problem hiding this comment.
Fixed wording. Thanks for catching that!
ritamerkl
approved these changes
Sep 19, 2025
Pauliusd01
approved these changes
Sep 22, 2025
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
I included a number of small fixes from several Jira feedback tickets:
Started()needs to be called beforeSetTimeout(), as requested via user feedback.platformUserAccountXXXproperties and theFindUserByAccountmethod on the InputUser struct. These were not documented, but DocFx still generates empty documentation for them unless they are explicitly filtered out.JoinPlayersWhenJoinActionIsTriggeredbehavior, as discussed with @ritamerkl on the input-team channel. Also added doc forJoinPlayersWhenJoinActionIsTriggeredvalue itself.OnClick(), as requested via user feedback.Testing status & QA
Overall Product Risks
Very low risk: documentation changes only.
Comments to reviewers
I added the 3 reviewers who contributed the last time. Please let me know if I am missing anyone.
Checklist
Before review:
During merge:
DOCS: ___After merge: