Skip to content

Conversation

@lyndon-unity
Copy link
Collaborator

Description

Updated InputValue API documentation

  • Documented common types
  • Added example
  • Documented isPressed property

Testing status & QA

Reviewed generated docs using the DocTools package and checked the validation results

Overall Product Risks

  • Complexity: low
  • Halo Effect: low

Comments to reviewers

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.

After merge:

  • Create forward/backward port if needed. If you are blocked from creating a forward port now please add a task to ISX-1444.

Updated InputValue documentation
@lyndon-unity lyndon-unity requested review from duckets and ekcoh December 2, 2024 14:06
@lyndon-unity lyndon-unity added the DocsQualityWeek2024 Temporary label for docs week label Dec 2, 2024
@lyndon-unity
Copy link
Collaborator Author

Hmm generated example layout isn't indented as I would expect
image

Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

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

Approving it since I think its a good improvement, but added a bunch of minor comments which @duckets might also provide guidance regarding

@ekcoh
Copy link
Collaborator

ekcoh commented Dec 2, 2024

@lyndon-unity PR title is not conforming. Prefix by "DOCS: "

@lyndon-unity
Copy link
Collaborator Author

Seems generated code in other areas looks the same so this might just be a preview thing:

image

@lyndon-unity lyndon-unity changed the title Updated InputValue documentation DOCS: Updated InputValue documentation Dec 2, 2024
@lyndon-unity
Copy link
Collaborator Author

@lyndon-unity PR title is not conforming. Prefix by "DOCS: "

Fixed

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.

rather minor proposals, approving

@ekcoh
Copy link
Collaborator

ekcoh commented Dec 3, 2024

Seems to be CI failures:

PVP-150-1: UnityEngine.InputSystem.InputValue: TValue Get(): in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.InputValue: isPressed: in block context (only allowed in top-level context)
PVP-150-1: UnityEngine.InputSystem.InputValue: isPressed: unexpected ; use instead

Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

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

CI failures

Copy link
Collaborator

@ekcoh ekcoh left a comment

Choose a reason for hiding this comment

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

LGTM, nice to see CI problems fixed

@lyndon-unity lyndon-unity merged commit 39deb60 into develop Dec 4, 2024
77 checks passed
@lyndon-unity lyndon-unity deleted the docs-quality-week-2024-inputvalue branch December 4, 2024 09:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

DocsQualityWeek2024 Temporary label for docs week

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants