Add log_to_attrs decorator to scale function

[niksirbi]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?

Supersedes #553, see that PR (and the discussions below it) for a justification.

What does this PR do?

• Adds the log_to_attrs decorator (previously only used for filtering functions) to the movement.transforms.scale function
• Documents its effects in the scale function's docstring (as notes and examples)
• Updates the tests accordingly

References

#553

How has this PR been tested?

Existing test for the scale function were updated to check for the contents of log entries.

Is this a breaking change?

No.

Does this PR require an update to the documentation?

The docstring has been expanded.

Checklist:

• The code has been tested locally
• Tests have been added to cover all new functionality
• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (8eeecc4) to head (7421b3a).
Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #604   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           32        32           
  Lines         1784      1786    +2     
=========================================
+ Hits          1784      1786    +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

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

[niksirbi]

I've requested a code review from @lochhh, but @hummuscience it would also be great to hear how this feature works for you. Basically, the arguments passed to the scale function are now stored in the log attribute of the scaled output data array, allowing you to "reconstruct" a history of transformations applied to the data. Each successive scale adds a new entry to the log.

[niksirbi]

Note to self: this PR needs to be rebased and updated after #606 is merged, because of changes I'm making to the log_to_attrs decorator itself.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud