DOCS: How to use processors

[ritamerkl]

Description

This adds more documentation on how to use processors.

Testing status & QA

No testing

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.

[lilisha-unity]

I did my first pass on the PR. Please fix the note formatting and replace the placeholder image alt text with something more descriptive. Also, there are quite a few sentences written in passive voice—please rewrite them in active voice where appropriate. You can refer to the Unity style guide for reference: https://docs-style-guide.unity.com/style/use-active-voice.

[jfreire-unity]

In that case, a Scale Processor on the Bindings can help preprocess the values before clamping them (Processors on Actions are applied after Processors on Bindings).

I think it would be good to have an example or expand an existing one to show examples of order of execution of processors. Always better to have an example than saying it in words IMO.

[ritamerkl]

Do you have a specific example in mind?

[codecov-git.colasdn.top]

Codecov Report

All modified and coverable lines are covered by tests ✅

@@           Coverage Diff            @@
##           develop    #2171   +/-   ##
========================================
  Coverage    65.44%   65.44%           
========================================
  Files          367      367           
  Lines        53505    53505           
========================================
  Hits         35019    35019           
  Misses       18486    18486           

Flag	Coverage Δ
linux_2021.3_project	70.41% <ø> (ø)
linux_2022.3_project	65.27% <ø> (ø)
linux_6000.0_project	65.34% <ø> (ø)
linux_6000.1_project	65.34% <ø> (ø)
linux_trunk_project	65.34% <ø> (-0.02%)	⬇️
mac_2021.3_pkg	5.41% <ø> (ø)
mac_2021.3_project	70.42% <ø> (ø)
mac_2022.3_pkg	5.19% <ø> (ø)
mac_2022.3_project	65.29% <ø> (ø)
mac_6000.0_pkg	5.20% <ø> (ø)
mac_6000.0_project	65.37% <ø> (ø)
mac_6000.1_pkg	5.20% <ø> (ø)
mac_6000.1_project	65.38% <ø> (+0.01%)	⬆️
mac_trunk_pkg	5.20% <ø> (ø)
mac_trunk_project	65.36% <ø> (ø)
win_2021.3_pkg	5.42% <ø> (ø)
win_2021.3_project	70.49% <ø> (ø)
win_2022.3_pkg	5.20% <ø> (ø)
win_2022.3_project	65.37% <ø> (ø)
win_6000.0_pkg	5.20% <ø> (ø)
win_6000.0_project	65.44% <ø> (+<0.01%)	⬆️
win_6000.1_pkg	5.20% <ø> (ø)
win_6000.1_project	65.45% <ø> (ø)
win_trunk_pkg	5.20% <ø> (ø)
win_trunk_project	65.44% <ø> (-0.01%)	⬇️

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

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[lilisha-unity]

Finished my review with some suggestions.