Patrick 0.1.0 will have backwards incompatible changes

michaelquinn32 commented 2 years ago

Hi Double ML team!

Thanks for using patrick for creating parameterized tests.

I am going to start the process of releasing a backwards incompatible change in the package.

In the past, the undocumented test_name parameter could be used to in cases data frames and as an argument for naming tests
I am moving this to a documented argument in with_parameters_test_that(). The argument is also getting the name .test_name in order to distinguish it from test cases passed by a user

In version 0.1.0, patrick will throw a warning about this change and rename input as appropriate. In the future, this warning will be dropped. Addressing it requires changing your use of test_name to .test_name.

Apologies for any inconvenience that this causes. Please let me know how else I can help.

Best wishes, Michael

MalteKurz commented 2 years ago

@michaelquinn32 Thanks for the heads up, we will adapt accordingly.

MalteKurz commented 2 years ago

I prepared a PR to fix this, see https://github.com/DoubleML/doubleml-for-r/pull/129. As it is not backwards compatible we need to wait for the release of patrick in version 0.1.0 to CRAN before we merge (otherwise CI fails). I also adapted the dependency accordingly, see https://github.com/DoubleML/doubleml-for-r/pull/129/files#diff-9cc358405149db607ff830a16f0b4b21f7366e3c99ec00d52800acebe21b231cL45.

@michaelquinn32 Would be great if you could quickly ping us in this issue when the patrick release in version 0.1.0 to CRAN is done.

DoubleML / doubleml-for-r

Patrick 0.1.0 will have backwards incompatible changes #128