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

remove superfluous backticks across pkg documentation #1158

Merged
merged 2 commits into from
Aug 23, 2024

Conversation

luisDVA
Copy link
Contributor

@luisDVA luisDVA commented Aug 20, 2024

addresses issue #1134
removed backticks around package names per the tidy style guide. In few cases I edited the text to say "the parsnip package..." for disambiguation. This backtick audit considered downlit linking and I left some package names with backticks intentionally. (I ran some of these edge cases by the posit crew during dev day).

Copy link
Contributor

@simonpcouch simonpcouch left a comment

Choose a reason for hiding this comment

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

Wonderful—a couple edits and then this should be ready to go. If you're still having issues with devtools::document() like those noted in the linked issue, feel free to just ask us to do it on your behalf!

Much appreciated, Luis!

NEWS.md Outdated
@@ -3,7 +3,7 @@

* `fit_xy()` currently raises an error for `gen_additive_mod()` model specifications as the default engine (`"mgcv"`) specifies smoothing terms in model formulas. However, some engines specify smooths via additional arguments, in which case the restriction on `fit_xy()` is excessive. parsnip will now only raise an error when fitting a `gen_additive_mod()` with `fit_xy()` when using the `"mgcv"` engine (#775).

* Aligned `null_model()` with other model types; the model type now has an engine argument that defaults to `"parsnip"` and is checked with the same machinery that checks other model types in the package (#1083).
* Aligned `null_model()` with other model types; the model type now has an engine argument that defaults to parsnip and is checked with the same machinery that checks other model types in the package (#1083).
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
* Aligned `null_model()` with other model types; the model type now has an engine argument that defaults to parsnip and is checked with the same machinery that checks other model types in the package (#1083).
* Aligned `null_model()` with other model types; the model type now has an engine argument that defaults to `"parsnip"` and is checked with the same machinery that checks other model types in the package (#1083).

Let's keep this one as-is, as it does indeed refer to the character string "parsnip"!

NEWS.md Outdated
@@ -121,7 +121,7 @@ This release of parsnip contains a number of new features and bug fixes, accompa

# parsnip 1.0.3

* Adds documentation and tuning infrastructure for the new `flexsurvspline` engine for the `survival_reg()` model specification from the `censored` package (@mattwarkentin, #831).
Copy link
Contributor

Choose a reason for hiding this comment

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

Generally, we try not to touch NEWS entries once they've made it to CRAN. Could you revert the changes to this file?

@luisDVA
Copy link
Contributor Author

luisDVA commented Aug 23, 2024

thanks Simon, I've restored the NEWS.md file from main

@simonpcouch simonpcouch merged commit d68b765 into tidymodels:main Aug 23, 2024
10 checks passed
Copy link

github-actions bot commented Sep 7, 2024

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 Sep 7, 2024
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