Skip to content

Conversation

@ekcoh
Copy link
Collaborator

@ekcoh ekcoh commented Dec 2, 2024

Description

Improved script API Doscs of InputAction.CallbackContext:

  • Added example
  • Extended description with links for struct type.

Testing status & QA

Reviewed generated XML docs in IDE inspector (Rider)
Generated docs via package docs tool.

Overall Product Risks

  • Complexity: very small
  • Halo Effect: very small

Comments to reviewers

Check language, compliance and example.

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.

@ekcoh ekcoh requested review from duckets and removed request for duckets December 2, 2024 11:42
@ekcoh ekcoh marked this pull request as ready for review December 2, 2024 13:23
@ekcoh ekcoh requested a review from duckets December 2, 2024 13:23
@lyndon-unity lyndon-unity added the DocsQualityWeek2024 Temporary label for docs week label Dec 2, 2024
@ekcoh
Copy link
Collaborator Author

ekcoh commented Dec 2, 2024

I noticed this one has malformed xmldoc so need to revisit that

Copy link
Collaborator

@lyndon-unity lyndon-unity left a comment

Choose a reason for hiding this comment

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

Small correction needed in the example code

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, mainly minor comments

@ekcoh ekcoh merged commit 8234e4f into develop Dec 11, 2024
77 checks passed
@ekcoh ekcoh deleted the docs-quality-week-2024-callbackcontext branch December 11, 2024 15:58
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