Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

consider renaming ?details_model_type_engine docs to ?model_type_engine #1226

Open
simonpcouch opened this issue Dec 11, 2024 · 0 comments
Open

Comments

@simonpcouch
Copy link
Contributor

After a couple weeks away from parsnip, I was trying to remember the convention for finding engine-specific help-files. I eventually remembered it was ?details_model_type_engine, e.g. ?details_linear_reg_glmnet, but this made me wonder if just using ?model_type_engine, e.g. ?linear_reg_glmnet, would make these more discoverable, as folks are probably thinking to type ?linear_reg to search for that documentation in the first place and would get autocomplete then.

For back-compatibility, this would probably just be an alias rather than a proper rename.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant