Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOCS: Trivial changes to documentation (batch changes to fix tiny typos) #2235

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 8 commits into
base: develop
Choose a base branch
from
Open

DOCS: Trivial changes to documentation (batch changes to fix tiny typos) #2235

wants to merge 8 commits into from

Conversation

unitALG
Copy link
Contributor

@unitALG unitALG commented Sep 16, 2025 •
edited
Loading

Description

There were 7 small fixes across the InputSystem documentation that were flagged via user-submitted feedback:

  • DOCATT-8566: Corrected typo in Adding Bindings section (Input Bindings manual page)
  • DOCATT-8597: Fixed typo in Composite Bindings section (Input Bindings manual page)
  • DOCATT-8841: Finished incomplete deviceLayoutName param description
  • DOCATT-8567: Closed the string in the example code in the docs for the Separator field and groups property
  • DOCATT-8990: Added closing quotation mark in property doc to avoid readers thinking that the sentence was cut off.
  • DOCATT-8580: Fixed InputInteractionContext::Canceled typo
  • DOCATT-8556: Fixed typo in InputUser.actions property

Testing status & QA

Generated documentation locally.

Overall Product Risks

Very, very low risk

  • Complexity: XXXXS
  • Halo Effect: none

Comments to reviewers

These should be straightforward to review but please reassign to another Input team member if you are unavailable.

Checklist

Before review:

  • No Changelog entry added (no substantive changes made).
  • No Tests added/changed.
  • Trivial doc changes only.

During merge:

  • Commit message for squash-merge is prefixed with one of the list:
    • DOCS: Trivial changes to documentation.

After merge:

  • No ports necessary.

@unitALG
DOCATT-8580: Fixed InputInteractionContext::Canceled typo
548760d
@unitALG
DOCATT-8990: Added closing quotation mark in property doc
b3ff5cb 
- The reader thought the sentence was cut off, but it was just missing the closing quotation.
@unitALG
DOCATT-8567: Closed the string in the example code in the docs for th…
ce91a2e 
…e Separator field and groups property
@unitALG
DOCATT-8841: Finished incomplete deviceLayoutName param description
045386a 
- Finished the sentence using other similar explanations from InputSystem/Actions/InputActionRebindingExtensions.cs and InputSystem/Actions/InputBinding.cs.
@unitALG
DOCATT-8597: Fix typo on Input Bindings manual page
c44f7b4
@unitALG
DOCATT-8566: Corrected typo in Adding Bindings section (Input Binding…
28796e4 
…s page)
@unitALG
DOCATT-8556: Fixed typo in InputUser.actions property
2773519
@unitALG unitALG requested a review from ritamerkl September 16, 2025 01:21
@unitALG unitALG self-assigned this Sep 16, 2025
@unity-cla-assistant
Copy link

unity-cla-assistant commented Sep 16, 2025 •
edited
Loading

CLA assistant check
All committers have signed the CLA.

@codecov-github-com
Copy link

codecov-github-com bot commented Sep 16, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2235      +/-   ##
===========================================
+ Coverage    68.14%   76.71%   +8.57%     
===========================================
  Files          367      465      +98     
  Lines        53685    87919   +34234     
===========================================
+ Hits         36584    67448   +30864     
- Misses       17101    20471    +3370
Flag Coverage Δ
inputsystem_MacOS_2021.3 5.91% <ø> (?)
inputsystem_MacOS_2021.3_project 78.06% <ø> (?)
inputsystem_MacOS_2022.3 5.37% <ø> (?)
inputsystem_MacOS_2022.3_project 74.58% <ø> (?)
inputsystem_MacOS_6000.0 5.19% <ø> (?)
inputsystem_MacOS_6000.0_project 76.50% <ø> (?)
inputsystem_MacOS_6000.2 5.19% <ø> (?)
inputsystem_MacOS_6000.2_project 76.50% <ø> (?)
inputsystem_MacOS_6000.3 5.19% <ø> (?)
inputsystem_MacOS_6000.3_project 76.50% <ø> (?)
inputsystem_MacOS_6000.4 5.19% <ø> (?)
inputsystem_MacOS_6000.4_project 76.50% <ø> (?)
inputsystem_Ubuntu_2021.3 5.91% <ø> (?)
inputsystem_Ubuntu_2021.3_project 77.96% <ø> (?)
inputsystem_Ubuntu_2022.3 5.38% <ø> (?)
inputsystem_Ubuntu_2022.3_project 74.39% <ø> (?)
inputsystem_Ubuntu_6000.0 5.19% <ø> (?)
inputsystem_Ubuntu_6000.0_project 76.32% <ø> (?)
inputsystem_Ubuntu_6000.2 5.19% <ø> (?)
inputsystem_Ubuntu_6000.2_project 76.32% <ø> (?)
inputsystem_Ubuntu_6000.3 5.19% <ø> (?)
inputsystem_Ubuntu_6000.3_project 76.32% <ø> (?)
inputsystem_Ubuntu_6000.4 5.19% <ø> (?)
inputsystem_Ubuntu_6000.4_project 76.32% <ø> (?)
inputsystem_Windows_2021.3 5.91% <ø> (?)
inputsystem_Windows_2021.3_project 78.20% <ø> (?)
inputsystem_Windows_2022.3 5.37% <ø> (?)
inputsystem_Windows_2022.3_project 74.72% <ø> (?)
inputsystem_Windows_6000.0 5.19% <ø> (?)
inputsystem_Windows_6000.0_project 76.64% <ø> (?)
inputsystem_Windows_6000.2 5.19% <ø> (?)
inputsystem_Windows_6000.2_project 76.64% <ø> (?)
inputsystem_Windows_6000.3 5.19% <ø> (?)
inputsystem_Windows_6000.3_project 76.64% <ø> (?)
inputsystem_Windows_6000.4 5.19% <ø> (?)
inputsystem_Windows_6000.4_project 76.64% <ø> (?)

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

Files with missing lines Coverage Δ
...putsystem/InputSystem/Actions/IInputInteraction.cs 79.16% <ø> (ø)
...utSystem/Actions/InputActionRebindingExtensions.cs 82.96% <ø> (ø)
...ty.inputsystem/InputSystem/Actions/InputBinding.cs 75.26% <ø> (ø)
...putsystem/InputSystem/Controls/InputControlPath.cs 87.91% <ø> (ø)
...inputsystem/InputSystem/Plugins/Users/InputUser.cs 86.98% <ø> (ø)

... and 100 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@K-Tone K-Tone self-requested a review September 16, 2025 09:43
ritamerkl
ritamerkl approved these changes Sep 16, 2025
View reviewed changes
Copy link
Collaborator

@ritamerkl ritamerkl left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@K-Tone
Copy link
Collaborator

K-Tone commented Sep 16, 2025

One little comment would be that we prefer our PRs named like the original description suggested, for consistency. That affects the merge message once you decide to have it merged, it should be with one from the FIX:/CHANGE:/etc prefixes. Thanks.

@unitALG unitALG changed the title Doc quality sprint: batch changes to fix tiny typos DOCS: Trivial changes to documentation (batch changes to fix tiny typos) Sep 16, 2025
@unitALG
Copy link
Contributor Author

unitALG commented Sep 19, 2025 •
edited
Loading

Just to warn you, I don't have sufficient permission to merge this branch into the develop branch myself. Do you need to wait for the tests to finish running before merging?

Anyways, I'm not sure why the tests keep hanging. Should I wait for a particular time of the day to restart them?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@K-Tone K-Tone K-Tone approved these changes

@ritamerkl ritamerkl ritamerkl approved these changes

Assignees

@unitALG unitALG

Labels
DOCATT_DocsQualityWeek
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@unitALG @unity-cla-assistant @K-Tone @ritamerkl