aeye-lab / pymovements

A python package for processing eye movement data
https://pymovements.readthedocs.io
MIT License
57 stars 11 forks source link

fix!: correct pixel origin string to upper left instead of lower left #710

Closed dkrako closed 3 months ago

dkrako commented 3 months ago

Description

The pixel origin lower left is actually upper left. Luckily all logic is correct, just the naming wrong.

I didn't create any deprecation as this is a serious misnomer a user should be informed about the change. All dataset definitions are updated in this PR, so in case of the public datasets nothing has to be changed. In case of local datasets the user will be notified to change the experiment definition to upper left this way.

I think this is the best solution, as adding the correct calculation for lower left (and potentially others) would result in silent errors for users which created dataset definitions with pymovements<v0.18.0. This way we have at least a few versions inbetween that notify the user of this bugfix.

Implemented changes

Type of change

How Has This Been Tested?

Checklist:

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (4adbd9d) to head (d126048).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #710 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 57 57 Lines 2703 2705 +2 Branches 697 698 +1 ========================================= + Hits 2703 2705 +2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.