Skip to content

Conversation

@amanda-butler-unity
Copy link
Collaborator

Fix user-reported error in code snippet

Description

This PR addresses user-reported DOCATT-9051 to fix an error in the code snippet.

Testing status & QA

N/A - documentation-only change

Overall Product Risks

Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.

  • Complexity: 0
  • Halo Effect: 0

This is a documentation-only change

Comments to reviewers

Please make sure this change is accurate.

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.

Fix user-reported error in code snippet
@u-pr-agent
Copy link
Contributor

u-pr-agent bot commented Dec 19, 2025

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

🎫 Ticket compliance analysis ✅

DOCATT-9051 - Fully compliant

Compliant requirements:

  • Change the variable name in the third code snippet from 'submit' to 'submitAction' when calling WasReleasedThisFrame().
⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

This is a trivial documentation fix involving a single variable name change in a markdown file.
🏅 Score: 100

The PR accurately fixes the reported typo in the documentation code snippet as requested in the ticket.
🧪 No relevant tests
🔒 No security concerns identified
⚡ No major issues detected
  • Update review

🤖 Helpful? Please react with 👍/👎 | Questions❓Please reach out in Slack #ask-u-pr-agent

@u-pr-agent
Copy link
Contributor

u-pr-agent bot commented Dec 19, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

@codecov-github-com
Copy link

codecov-github-com bot commented Dec 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

@@             Coverage Diff             @@
##           develop    #2305      +/-   ##
===========================================
- Coverage    77.95%   77.93%   -0.03%     
===========================================
  Files          477      477              
  Lines        97419    97445      +26     
===========================================
- Hits         75943    75941       -2     
- Misses       21476    21504      +28     
Flag Coverage Δ
inputsystem_Windows_2022.3 5.54% <ø> (-0.01%) ⬇️
inputsystem_Windows_6000.0 5.32% <ø> (-0.01%) ⬇️
inputsystem_Windows_6000.2 5.32% <ø> (-0.01%) ⬇️

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

see 3 files with indirect coverage changes

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

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