Skip to content

Commit

Permalink
docs: 🏗️ include path arg of path functions in interface doc (#1124)
Browse files Browse the repository at this point in the history
## Description

Add and describe the path argument to the `path_` functions.

<!-- Select quick/in-depth as necessary -->
This PR needs a quick review.

## Checklist

- [x] Updated documentation
- [x] Ran `just run-all`
  • Loading branch information
lwjohnst86 authored Mar 11, 2025
1 parent b7599c7 commit d72d831
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/design/interface/functions.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -274,6 +274,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 @@ -284,25 +286,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

0 comments on commit d72d831

Please sign in to comment.