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.

Sign up for GitHub

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

docs: 🏗️ include path arg of path functions in interface doc #1124

Merged
merged 1 commit into from
Mar 11, 2025
Merged

docs: 🏗️ include path arg of path functions in interface doc #1124

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions docs/design/interface/functions.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,8 @@ flowchart
## Path functions

- All of these functions output a path object.
- All of these functions have an optional `path` argument that defaults to
the current working directory.
- The paths returned by all of these functions are paths that exist,
so all include a `check_is_dir()` or `check_is_file()` check.
- If the wrong `resource_id` is given, an error message will include a
Expand All @@ -287,25 +289,25 @@ flowchart
See the help documentation with `help(path_properties)` for more
details.

### {{< var done >}} `path_resources()`
### {{< var done >}} `path_resources(path)`

See the help documentation with `help(path_resources)` for more details.

### {{< var done >}} `path_resource(resource_id)`
### {{< var done >}} `path_resource(resource_id, path)`

See the help documentation with `help(path_resource)` for more details.

### {{< var done >}} `path_resource_raw(resource_id)`
### {{< var done >}} `path_resource_raw(resource_id, path)`

See the help documentation with `help(path_resource_raw)` for more
details.

### {{< var done >}} `path_resource_raw_files(package_id, resource_id)`
### {{< var done >}} `path_resource_raw_files(resource_id, path)`

See the help documentation with `help(path_resource_raw_files)` for more
details.

### {{< var done >}} `path_resource_data(package_id, resource_id)`
### {{< var done >}} `path_resource_data(resource_id, path)`

See the help documentation with `help(path_resource_data)` for more
details.
Expand Down