Add dev checklists for new models/engines/engine docs #1225
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hfrick
commented
Dec 10, 2024
|
|
||
| All these items should be added to *parsnip*, unless otherwise specified. | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Using a code block around the actual checklist, so that we hopefully get a copy button on the rendered pkgdown site. The intend is to c+p into a github issue. Plus, we'll see the rendered version of the checklists with the links to examples etc in the github issue.
hfrick
commented
Dec 10, 2024
|
|
||
| ## Checklist for documenting a new engine | ||
|
|
||
| Engine documentation always goes into parsnip, regardless of where the engine lives. |
There was a problem hiding this comment.
I was considering moving this sentence into the code block so that it gets copied over but I landed on "we all remember this one". Happy to move it though if you think that'd be beneficial.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Moving the checklists here for better visibility, instead of tidymodels/tidymodels#97