From b999fb53d32018a3bca40b95aa2806607a699b2e Mon Sep 17 00:00:00 2001
From: Michael Chirico <michaelchirico4@gmail.com>
Date: Fri, 11 Oct 2024 22:16:17 -0700
Subject: [PATCH] More explicit on documenting data sets

---
 vignettes/rd-other.Rmd | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/vignettes/rd-other.Rmd b/vignettes/rd-other.Rmd
index d646e1c2..d06381ff 100644
--- a/vignettes/rd-other.Rmd
+++ b/vignettes/rd-other.Rmd
@@ -44,9 +44,10 @@ This means you need to document them in a slightly different way: instead of doc
 #' }
 #' 
 #' @source {ggplot2} tidyverse R package.
+"diamonds"
 ```
 
-Note the use of two additional tags that are particularly useful for documenting data:
+This generates documentation for the `data(diamonds)` object. Note the use of two additional tags that are particularly useful for documenting data:
 
 -   `@format`, which gives an overview of the structure of the dataset.
     This should include a **definition list** that describes each variable.