Skip to content

Conversation

@lyndon-unity
Copy link
Collaborator

Description

Updated InputStateHistory documentation

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.

@lyndon-unity lyndon-unity requested review from duckets and ekcoh December 4, 2024 16:03
@lyndon-unity lyndon-unity added the DocsQualityWeek2024 Temporary label for docs week label Dec 5, 2024
@lyndon-unity lyndon-unity merged commit e8e75c7 into develop Dec 10, 2024
77 checks passed
@lyndon-unity lyndon-unity deleted the docs-quality-week-2024-inputstatehistory branch December 10, 2024 23:46
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.

4 participants