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

Documentation unclear on the pkg parameter #2584

Closed
telenskyt opened this issue Nov 5, 2024 · 2 comments
Closed

Documentation unclear on the pkg parameter #2584

telenskyt opened this issue Nov 5, 2024 · 2 comments

Comments

@telenskyt
Copy link

telenskyt commented Nov 5, 2024

The ?document (also build_manual and perhaps others) says about the pkg parameter

pkg - The package to use, can be a file path to the package or a package object. See as.package() for more information.

But what is "file path to the package"? What does "file path" mean? Shouldn't it be "directory" rather than file? Isn't it a path to the package directory, rather than some file? "File" suggests a path to the file in which the package is packed... The documentation of as.package() is not much clearer.

Could you please make the documentation clear and specific? This is quite confusing.

@jennybc
Copy link
Member

jennybc commented Nov 6, 2024

I believe "file path" to be a generally understood term that encompasses the path to a file or a folder.

A path (or filepath, file path, pathname, or similar) is a string of characters used to uniquely identify a location in a directory structure.

https://en.wikipedia.org/wiki/Path_(computing)

devtools has been on CRAN since 2011 and is widely used by R package developers, so this doesn't appear to be a source of widespread confusion.

@jennybc jennybc closed this as completed Nov 6, 2024
@telenskyt
Copy link
Author

File is a file, not a directory. I still don't know what should I supply to the pkg parameter!

Issue closed? So instead of spending like 2 minutes improving and clarifying the documentation, you just wipe it off the table. Nice.

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

No branches or pull requests

2 participants