Skip to content

Conversation

@stefanunity
Copy link
Collaborator

Description

Updated ButtonControl docs trying to fix as many negative points form the Score Explainer.

Testing status & QA

CI green.

Overall Product Risks

None

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.
  • [ X] 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.

@stefanunity stefanunity added the DocsQualityWeek2024 Temporary label for docs week label Dec 4, 2024
@stefanunity stefanunity changed the title FIX: Update ButtonControl API docs DOCS: Update ButtonControl API docs Dec 4, 2024
@stefanunity stefanunity merged commit cd53351 into develop Dec 4, 2024
78 checks passed
@stefanunity stefanunity deleted the docs-quality-week-2024-buttoncontrol branch December 4, 2024 12:34
/// </code>
/// </example>
/// </remarks>
/// <seealso cref="InputSettings.defaultButtonPressPoint"/>
Copy link
Collaborator

Choose a reason for hiding this comment

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

Rather than just removing these you can embed into the remarks section using the following in a sentence.
It is worth doing this as the links are useful.

<see cref="InputSettings.defaultButtonPressPoint"/>

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