Skip to content

Conversation

@topepo
Copy link
Member

@topepo topepo commented Feb 22, 2022

Most of the documentation was moved to README-DOCS.md and that file was edited and expanded.

@topepo topepo requested a review from juliasilge February 22, 2022 00:08
3. Knit the `.Rmd` file to `.md` so the `.Rd` file from step 1 can link it.
4. Once you are done, run `devtools::document()` (or use the RStudio IDE) to build the help files.

**Before you read the rest**, you probably don't have to generate the help files in this way yourself:
Copy link
Member

Choose a reason for hiding this comment

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

Is this kind of what you were getting at @topepo? The previous wording was confusing to me.

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure I understand the question. Can you elaborate?

Copy link
Member

Choose a reason for hiding this comment

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

I changed the text here to what I thought you were meaning because what was here before was confusing to me. So is the new text:

Before you read the rest, you probably don't have to generate the help files in this way yourself:

pretty much what you were getting at? What you want to say here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, it is. Thanks!

Copy link
Member

@juliasilge juliasilge left a comment

Choose a reason for hiding this comment

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

PR 666 😈 🤘

This looks good to me, although I left one question about an edit I made.

@topepo topepo merged commit 8f0678e into main Feb 23, 2022
@topepo topepo deleted the better-doc-docs branch February 23, 2022 15:50
@github-actions
Copy link
Contributor

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 Mar 10, 2022
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.

3 participants