Skip to content

Commit

Permalink
link to example pal extension package (closes #40)
Browse files Browse the repository at this point in the history
  • Loading branch information
simonpcouch committed Oct 15, 2024
1 parent 96cde35 commit bbdf23c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
4 changes: 1 addition & 3 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,7 @@ As-is, the package provides ergonomic LLM assistants for R package development:
* `"testthat"`: [Convert to testthat 3](https://simonpcouch.github.io/pal/reference/pal_testthat.html)
* `"roxygen"`: [Document functions with roxygen](https://simonpcouch.github.io/pal/reference/pal_roxygen.html)

That said, all you need to create your own pal is a markdown file with some instructions on how you'd like it to work.

<!-- TODO: decide the directory where those files would live, implement, and document -->
That said, all you need to create your own pal is a markdown file with some instructions on how you'd like it to work. See `prompt_new()` and `directory_load()` for more information, and [palpable](https://github.com/simonpcouch/palpable) for an example pal extension package.

## How much do pals cost?

Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,10 @@ development:
roxygen](https://simonpcouch.github.io/pal/reference/pal_roxygen.html)

That said, all you need to create your own pal is a markdown file with
some instructions on how you’d like it to work.

<!-- TODO: decide the directory where those files would live, implement, and document -->
some instructions on how you’d like it to work. See `prompt_new()` and
`directory_load()` for more information, and
[palpable](https://github.com/simonpcouch/palpable) for an example pal
extension package.

## How much do pals cost?

Expand Down
2 changes: 2 additions & 0 deletions vignettes/pal.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,6 @@ In that case, pal will register two custom pals when you call `library(pal)` (or
* Files without a `.md` extension are ignored.
* Files with a `.md` extension must contain only one hyphen in their filename, and the text following the hyphen must be one of `replace`, `prefix`, or `suffix`.

Custom pals can also be situated in R package. See [palpable](https://github.com/simonpcouch/palpable) for an example pal extension package.

For more in-depth documentation on adding custom pals, see the documentation for `prompt_new()` and friends as well as `directory_load()` and friends.

0 comments on commit bbdf23c

Please sign in to comment.