-
Notifications
You must be signed in to change notification settings - Fork 314
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
DOCS: Update Gamepad documentation #2073
base: develop
Are you sure you want to change the base?
Conversation
Addresses most issues to be solved in Docs Quality Week 2024 December
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Seems like there are more work to do unfortunately, see dry-run CI job:
PVP-150-1: UnityEngine.InputSystem.Gamepad: void OnAdded(): in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.Gamepad: void OnRemoved(): in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.Gamepad: void PauseHaptics(): in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.Gamepad: void PauseHaptics(): tag inside
PVP-150-1: UnityEngine.InputSystem.Gamepad: void ResumeHaptics(): in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.Gamepad: void ResumeHaptics(): tag inside
PVP-150-1: UnityEngine.InputSystem.Gamepad: void ResetHaptics(): in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.Gamepad: void ResetHaptics(): tag inside
Will follow up on errors next.
Missed those, will fix them as soon as I understand them :D |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, nice code examples
/// </summary> | ||
/// <value>Position of left trigger.</value> | ||
/// <remarks>The value's range goes from 0 to 1, where 0 represents the trigger not pressed at all, and 1 represents the trigger in its fully pressed position.</remarks> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
not pressed at all -> in it's neutral position, its -> it's
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
likewise in other parts of the code.
/// Does not cause GC allocation. | ||
/// | ||
/// Do <em>not</em> hold on to the value returned by this getter but rather query it whenever | ||
/// you need it. Whenever the gamepad setup changes, the value returned by this getter | ||
/// is invalidated. | ||
/// | ||
/// Alternately, if you want a single gamepad, you can use <see cref="current"/> for example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"if you want a single gamepad" sounds a bit odd. maybe "for querying a single gamepad"?
@@ -39,9 +39,13 @@ internal struct DualMotorRumble | |||
|| !Mathf.Approximately(highFrequencyMotorSpeed, 0f); | |||
|
|||
/// <summary> | |||
/// Reset motor speeds to zero but retain current values for <see cref="lowFrequencyMotorSpeed"/> | |||
/// and <see cref="highFrequencyMotorSpeed"/>. | |||
/// Reset motor speeds to zero. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this summary long enough to fit the requirements in count of characters?
Description
Updates Gamepad documentation based on Unity Package API Quality Standards by addressing Score Explanation issues:
Testing status & QA
Docs build on my machine.
Overall Product Risks
None
Comments to reviewers
Please let me know of any inconsistencies and improvements I should do.
Also, let me know if the approach to reuse code samples using
<example><inheritdoc cref="SetMotorSpeeds"/></example>
is ok. I didn't find a better way of doing a better code exampleChecklist
Before review:
During merge:
NEW: ___
.FIX: ___
.DOCS: ___
.CHANGE: ___
.RELEASE: 1.1.0-preview.3
.After merge: