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

link to info on model formulas in error message #1257

Merged
merged 2 commits into from
Nov 8, 2023

Conversation

simonpcouch
Copy link
Contributor

This PR follows up on tidymodels/parsnip#1015, where I put together a help-page on model formulas that we could link to throughout tidymodels errors and docs. I think this check would be a great place to spot folks who need this information but haven't found it yet.

Made sure to think through the "cascade" when putting these PRs together. With merging this PR as-is, this would put as at:

  • tune, then yardstick

and, independently,

  • parsnip, then recipes

@@ -279,9 +279,11 @@ inline_check <- function(x) {
cli::cli_abort(c(
x = "No in-line functions should be used here.",
i = "{cli::qty(length(funs))}The following function{?s} {?was/were} \\
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In order to not increase the number of i entries further, I opted to collapse the itemization onto the line where it's introduced. I believe this happens in a few other places in recipes already!

@simonpcouch
Copy link
Contributor Author

dev deployment of those docs are here!

Copy link
Member

@EmilHvitfeldt EmilHvitfeldt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good!

@simonpcouch simonpcouch merged commit 746b473 into main Nov 8, 2023
@simonpcouch simonpcouch deleted the parsnip-model-formula branch November 8, 2023 16:21
Copy link

This pull request has been automatically locked. If you believe you have found a related problem, please file a new issue (with a reprex https://reprex.tidyverse.org) and link to this issue.

@github-actions github-actions bot locked and limited conversation to collaborators Nov 23, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants