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

[wip] Shorten help for rows and columns arguments. #1669

Closed
wants to merge 2 commits into from

Conversation

olivroy
Copy link
Collaborator

@olivroy olivroy commented May 19, 2024

Not yet ready for review !

Summary

The first goal was to remove the mention the tidyselect::one_of (superseded by any_of + all_of.

Than, I realized there was a bit of duplication, so I looked into that.

  • When the default is everything(), shorten how the default is explained + don't link to everything() twice in man
  • Don't link to c() too often.
  • Personally, I have never used tidyselect helpers to select rows, (an expression is almost always more useful, so I want to highlight that), and maybe reduce prominence in man.
  • Possibly a topic would be more appropriate where all the ways to use rows and columns is explained (since that knowledge applies to all of gt, and not to any particular functions.
  • Ideally, I think it would be great to link to the topic, and only explain if there are exception to usage in that particular function (i.e. change of default, optional vs required etc.)
  • I may close this and reopen a PR where I gather data on how it is documented currently. to use @inheritParams safely without changing anything in man. than reopen a PR with the same intention as this one, but with minimal changes

I am opening to check-out my progress.

I will review shortly to ensure consitency, and will use @inheritParams as much as possible, unless some special info is shared.

i.e. in cols_hide(), I think it is worth mentioning how to hide columns with all missing values. 8901a1f

Before requesting review, I want to double-check that the style used is consistent.

I used r-lib/roxygen2#1594 to document, for faster iteration.

@olivroy
Copy link
Collaborator Author

olivroy commented May 23, 2024

Closing for now. Will maybe come back to this once doc duplication is reduced. (i.e. more PRs like #1676 )

@olivroy olivroy closed this May 23, 2024
@olivroy olivroy mentioned this pull request Jun 19, 2024
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant