From 21a06ad2b6184b381df54eba17cb0849c4286770 Mon Sep 17 00:00:00 2001
From: Mark Niemann-Ross <mark.niemannross@gmail.com>
Date: Wed, 15 May 2024 13:06:45 -0700
Subject: [PATCH] update description of tellme

---
 R/is_rpi.R | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/R/is_rpi.R b/R/is_rpi.R
index 34e3f3f..3436e4a 100644
--- 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