Figure mechanics for the DESCRIPTION chapter

hadley · Mar 29, 2023 · 7f13b03 · 7f13b03
1 parent 34cda25
commit 7f13b03
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 4 deletions.
diff --git a/description.Rmd b/description.Rmd
@@ -86,17 +86,21 @@ Description: A system for 'declaratively' creating graphics,
     and it takes care of the details.
 ```
 
-A good title and description are important, especially if you plan to release your package to CRAN, because they appear on the CRAN download page as follows:
+A good title and description are important, especially if you plan to release your package to CRAN, because they appear on the package's CRAN landing page as shown in @fig-cran-package-page:
 
-<!-- TODO: I know my hacky diagram might need replacement, but at least it's more up-to-date. -->
+<!-- Sara says: be sure there is a blank high res screenshot because prod will add text to the screenshot in the O'Reilly style. That blank screenshot is here as images/cran-package-ggplot2-clean.png. -->
 
 ```{r}
 #| label: fig-cran-package-page
 #| echo: false
 #| out-width: ~
 #| fig.cap: >
-#|   The CRAN page for ggplot2, highlighting Title and Description.
-knitr::include_graphics("diagrams/cran-package-ggplot2.png")
+#|   How Title and Description appear on ggplot2's CRAN page.
+#| fig.alt: >
+#|   A screenshot of the CRAN page for ggplot2, with two labelled boxes
+#|   indicating the text that comes from the Title and Description fields
+#|   in the DESCRIPTION file.
+knitr::include_graphics("images/cran-package-ggplot2.png")
 ```
 
 ::: callout-warning

diff --git a/images/cran-package-ggplot2-clean.png b/images/cran-package-ggplot2-clean.png
diff --git a/images/cran-package-ggplot2.key b/images/cran-package-ggplot2.key
diff --git a/diagrams/cran-package-ggplot2.png → images/cran-package-ggplot2.png b/diagrams/cran-package-ggplot2.png → images/cran-package-ggplot2.png