test: Test for warning when distance column and distance_cm specified

[jakobchwastek]

fix #610

[codecov[bot]]

Codecov Report

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

Comparison is base (9cada8b) 100.00% compared to head (619d0fd) 100.00%.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #615 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 53 53 Lines 2388 2388 Branches 599 599 ========================================= Hits 2388 2388 ```

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

[jakobchwastek]

The pix2deg_distance_experiment_and_distance_column_defaults_to_column test is failing now because we treat the warning it is triggering as error. Any suggestions on how to handle this? I would like to keep the test

https://github.com/aeye-lab/pymovements/blame/a95c1da4a23dbbb1f23229d90ed1203a21ace4f6/tests/unit/gaze/gaze_transform_test.py#L489

[dkrako]

The pix2deg_distance_experiment_and_distance_column_defaults_to_column test is failing now because we treat the warning it is triggering as error. Any suggestions on how to handle this? I would like to keep the test

https://github.com/aeye-lab/pymovements/blame/a95c1da4a23dbbb1f23229d90ed1203a21ace4f6/tests/unit/gaze/gaze_transform_test.py#L489

Move the test case to ta new function and add the expected warning to the parameters:

def test_gaze_transform_expected_frame_warning(
        gaze_init_kwargs, transform_method, transform_kwargs, expected_result, expected_warning,
):
    with pytest.warns(expected_warning) as excinfo:
      gaze = pm.GazeDataFrame(**gaze_init_kwargs)
      gaze.transform(transform_method, **transform_kwargs)

    assert_frame_equal(gaze.frame, expected.frame)

[jakobchwastek]

Should be done