search

tidymodels / dials

Tools for creating tuning parameter values
https://dials.tidymodels.org/
Other
113 stars 27 forks source link

link docs for `encode_unit()` #322

Closed hfrick closed 8 months ago

hfrick commented 8 months ago

fixes #320

This connectes the documentation for the generic (without the original argument) and the S3 method of quantitative parameters (with the original argument) so that we don't document an "unused" argument anymore.

The argument original was documented as "not currently working" so I was considering removing it, rather than changing the documentation, and did some github archeology.

The documentation is from https://github.com/tidymodels/dials/commit/ae4e9008d5d03ff7fe37cc892be2bdfeb113c278.

The state of the function then had a code comment about missing the inverse transformation and https://github.com/tidymodels/dials/issues/54. That comes "for free" with the scales package though, so it was included in https://github.com/tidymodels/dials/commit/198384b2c0b9c71e5c1949167dffb579592d47de. That commit didn't include an update to the docs but I think it has been working as intended from then on, so I've updated the docs accordingly.