update description of tellme

mnr · May 15, 2024 · 21a06ad · 21a06ad
1 parent ab2641c
commit 21a06ad
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/R/is_rpi.R b/R/is_rpi.R
@@ -2,7 +2,8 @@
 #'
 #' Returns TRUE if this code is running on a Raspberry Pi
 #'
-#' @param tellme
+#' @param tellme if TRUE the is.rpi will return the device-tree/model.
+#'     This typically looks like "Raspberry Pi 5 Model B Rev 1.0"
 #'
 #' @return TRUE if running on a Raspberry Pi.
 #'          if tellme = TRUE, return the model string