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

Move all steps' tidy docs #701

Merged
merged 18 commits into from Apr 28, 2021
Merged

Move all steps' tidy docs #701

merged 18 commits into from Apr 28, 2021

Conversation

juliasilge
Copy link
Member

Closes #695

This PR moves the documentation for tidy methods from the individual recipe step/check pages to the already-existing centralized tidy page.

Is there a way to change the order of these so that this isn't located at "step_BoxCox"?

@DavisVaughan
Copy link
Member

Is there a way to change the order of these so that this isn't located at "step_BoxCox"?

I don't think so. I think this is some bad interaction between the @name tag, which isn't getting respected, and the fact that we are forcibly showing an S3 method tidy.step_BoxCox on the man page. For some reason that is overriding the @name tag, and since that one is the first alphabetically, it shows up in the man page as \name{tidy.step_BoxCox}.

Note that we do still get an alias for tidy.recipe, i.e. \alias{tidy.recipe} in the man file, but the actual name of the file in the top left corner of the man page still shows tidy.step_BoxCox, which feels like a roxygen bug.

I have the same issue in clock. i.e. ?clock::`clock-arith` points to the right page, but the name in the top left corner is vec_arith.clock_year_day, which is the first method alphabetically.

Copy link
Member

@DavisVaughan DavisVaughan left a comment

Choose a reason for hiding this comment

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

Whew!

@github-actions
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 May 13, 2021
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.

Removing tidy.*() from Github Pages
2 participants