Skip to content

DOCS: Feedback for docs#2456

Open
suearkinunity wants to merge 9 commits into
developfrom
docs/feedback-tickets-interactions
Open

DOCS: Feedback for docs#2456
suearkinunity wants to merge 9 commits into
developfrom
docs/feedback-tickets-interactions

Conversation

@suearkinunity

@suearkinunity suearkinunity commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator

Description

User feedback for docs.

Testing status & QA

Docs only

Overall Product Risks

Docs only

Comments to reviewers

Docs only.

Checklist

Before review:

  • Changelog entry added.
    • Explains the change in Changed, Fixed, Added sections.
    • For API change contains an example snippet and/or migration example.
    • JIRA ticket linked, example (case %%). If it is a private issue, just add the case ID without a link.
    • Jira port for the next release set as "Resolved".
  • Tests added/changed, if applicable.
    • Functional tests Area_CanDoX, Area_CanDoX_EvenIfYIsTheCase, Area_WhenIDoX_AndYHappens_ThisIsTheResult.
    • Performance tests.
    • Integration tests.
  • Docs for new/changed API's.
    • Xmldoc cross references are set correctly.
    • Added explanation how the API works.
    • Usage code examples added.
    • The manual is updated, if needed.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • NEW: ___.
    • FIX: ___.
    • DOCS: ___.
    • CHANGE: ___.
    • RELEASE: 1.1.0-preview.3.

@cla-assistant-unity

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Updating link... but I have a bad feeling about this link format
@suearkinunity suearkinunity changed the title Updating built-in-interactions DOCS: Feedback for docs Jul 22, 2026
@codecov-github-com

codecov-github-com Bot commented Jul 22, 2026

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff            @@
##           develop    #2456   +/-   ##
========================================
  Coverage    78.95%   78.95%           
========================================
  Files          767      767           
  Lines       140780   140780           
========================================
  Hits        111158   111158           
  Misses       29622    29622           
Flag Coverage Δ
inputsystem_Windows_6000.0 5.31% <ø> (ø)
inputsystem_Windows_6000.3 5.31% <ø> (ø)
inputsystem_Windows_6000.6 5.30% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

ℹ️ Need help interpreting these results?

Comment thread Packages/com.unity.inputsystem/Documentation~/supported-devices-reference.md Outdated
@suearkinunity
suearkinunity marked this pull request as ready for review July 22, 2026 11:05

@u-pr u-pr Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Harness Review

Needs changes

A few of the doc edits still drift away from the runtime/API behavior they describe, so the updated guidance would mislead readers in some important spots.

Reviewed commit 082be5bc

🤖 Helpful? 👍/👎

Comment thread Packages/com.unity.inputsystem/Documentation~/event-processing.md Outdated
## MultiTap

A [`MultiTapInteraction`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) requires the user to press and release a Control within [`tapTime`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) seconds [`tapCount`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) times, with no more then [`tapDelay`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) seconds passing between taps, for the Interaction to trigger. You can use this to detect double-click or multi-click gestures.
You can use `MultiTap` to detect double-click or multi-click gestures. For a [`MultiTapInteraction`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) to trigger, the user must press a control and release it within [`tapTime`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) seconds, repeating the press-and-release process [`tapCount`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) times. There can't be more than [`tapDelay`](xref:UnityEngine.InputSystem.Interactions.MultiTapInteraction) seconds between taps.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2

While touching the MultiTap section, the default-value table just below still says tapDelay defaults to 2 * tapTime. The implementation actually falls back to InputSettings.multiTapDelayTime when tapDelay is unset, so this section still documents the wrong default spacing between taps and will mislead anyone tuning multi-click timing. Please update the table row to match the runtime behavior.

🤖 Helpful? 👍/👎

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jfreire-unity is u-pr right?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep, u-pr is right (even though your changes are not affecting it; it just found out another doc inconsistency with the implementation)

@suearkinunity suearkinunity Jul 23, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you check my change, please? I basically copy/pasted u-pr.

aa03598

@jpriyas jpriyas left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes. Just added a couple of suggestions.

Comment thread Packages/com.unity.inputsystem/Documentation~/supported-devices-reference.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/supported-devices-reference.md Outdated
Comment thread Packages/com.unity.inputsystem/Documentation~/event-processing.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants