document options in a central place

simonpcouch · Oct 28, 2024 · 7da14af · 7da14af
1 parent 24e1ee8
commit 7da14af
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 0 deletions.
diff --git a/R/options.R b/R/options.R
@@ -0,0 +1,13 @@
+#' Options used by the pal package
+#'
+#' @description
+#' The pal package makes use of three notable user-facing options:
+#'
+#' * `.pal_dir` is the directory where pal prompts live. See the pal [directory]
+#'   help-page for more information.
+#' * `.pal_fn` and `.pal_args` determine the underlying LLM powering each pal.
+#'   See the "Choosing a model" section of `vignette("pal", package = "pal")`
+#'   for more information.
+#'
+#' @name pal_options
+NULL
diff --git a/_pkgdown.yml b/_pkgdown.yml
@@ -12,6 +12,7 @@ reference:
     contents:
     - starts_with("prompt")
     - starts_with("directory")
+    - pal_options
   - title: Pals for package development
     contents:
     - pal_roxygen

diff --git a/man/pal_options.Rd b/man/pal_options.Rd