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

Use 'browseVignettes' instead of 'vignettes' for browsing by package. #388

Open
wants to merge 1 commit into
base: gh-pages
from

Conversation

Projects
None yet
2 participants
@MilesMcBain
Contributor

MilesMcBain commented May 27, 2018

It's more user-friendly since it saves follow typing of long vignette names.

Use 'browseVignettes' instead of 'vignettes' for browsing by package.
It's more user-friendly since it saves follow typing of long vignette names.
`package-name`, and `vignette("vignette-name")` will open the specified vignette.
Without any arguments, `vignette()` and `vignette("vignette-name")` will open the
specified vignette. To see a list of vignettes for a given package as a webpage with
browsable links use `browswVignettes(package = "package-name")`.

This comment has been minimized.

@naupaka

naupaka May 27, 2018

Member

Typo: "browswVignettes"

Without any arguments, `vignette()` will list all vignettes for all installed packages;
`vignette(package="package-name")` will list all available vignettes for
`package-name`, and `vignette("vignette-name")` will open the specified vignette.
Without any arguments, `vignette()` and `vignette("vignette-name")` will open the

This comment has been minimized.

@naupaka

naupaka May 27, 2018

Member

I think this is a typo? On its own, vignette() doesn't open any vignettes, it lists all available for installed packages. In the proposed change, this is not described.

@naupaka

naupaka requested changes May 27, 2018 edited

A couple suggestions to improve the PR.

@MilesMcBain

This comment has been minimized.

Contributor

MilesMcBain commented May 27, 2018

Damn sorry, yes there is text missing from the start. I just wanted to suggest using browseVignettes to view by package instead of vignette.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment