From 60b323b1c13ff51d092fddf3add46d20f03006c7 Mon Sep 17 00:00:00 2001 From: Jasmine Daly Date: Mon, 29 Jul 2024 10:18:27 -0400 Subject: [PATCH 1/2] adding the title case issue --- website/description_issues.qmd | 28 ++++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/website/description_issues.qmd b/website/description_issues.qmd index 99eba83..54475b2 100644 --- a/website/description_issues.qmd +++ b/website/description_issues.qmd @@ -5,7 +5,7 @@ format: css: style.css --- -# Formatting Software Names +# Formatting Software Names ## Problem @@ -28,7 +28,7 @@ Description: The goal of 'readr' is to provide a fast and friendly way to cleanly failing when data unexpectedly changes. ``` ---- +------------------------------------------------------------------------ # Explaining Acronyms @@ -43,3 +43,27 @@ Document all non-obvious acronyms in the [cran-comments.md](https://usethis.r-li ### Details Most acronyms that are not widely known should be explained. For example, you don’t have to explain *OLS*, *SEO*, or *DNA* but explanations should be provided for: *MEFM* or *OCCDS*. If you are unsure of the acronyms common knowledge, please document all acronyms in the package. + +------------------------------------------------------------------------ + +# Title Case + +## Problem + +The package Title field in the DESCRIPTION file is not in Title Case and the first letter of some or all of the words in the title are lowercase. + +## Solution + +The package Title field in the DESCRIPTION file must be in Title Case, except words like "a", "the" or "of". + +### Details + +Determining Title Case automatically can be challenging due to word significance being only known by the package author. The function `toTitleCase()` can assist with transforming sentences into Title Case from the 'tools' package. + +```{r} +tools::toTitleCase("web application framework for R") +``` + +::: callout-note +There are some exceptions to using Title Case for quoting longer works like book titles and shorter works like research papers - [Learn more](https://www.scribbr.com/academic-writing/title-case/#:~:text=In%20title%20case%2C%20the%20first,title%2C%20subtitle%2C%20or%20heading.). +::: From bc3ec74e1f8760f867c1a827c24be749d9302c5a Mon Sep 17 00:00:00 2001 From: Jasmine Daly Date: Mon, 5 Aug 2024 11:32:30 -0400 Subject: [PATCH 2/2] update callout tip with WRE mention --- website/description_issues.qmd | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/website/description_issues.qmd b/website/description_issues.qmd index 54475b2..fcbdf78 100644 --- a/website/description_issues.qmd +++ b/website/description_issues.qmd @@ -65,5 +65,7 @@ tools::toTitleCase("web application framework for R") ``` ::: callout-note -There are some exceptions to using Title Case for quoting longer works like book titles and shorter works like research papers - [Learn more](https://www.scribbr.com/academic-writing/title-case/#:~:text=In%20title%20case%2C%20the%20first,title%2C%20subtitle%2C%20or%20heading.). +There are some exceptions to using Title Case for quoting longer works like book titles and shorter works like [research papers](https://www.scribbr.com/academic-writing/title-case/#:~:text=In%20title%20case%2C%20the%20first,title%2C%20subtitle%2C%20or%20heading.). + +It is also not recommended to [mention package names](https://cran.r-project.org/doc/manuals/r-devel/R-exts.html#The-DESCRIPTION-file) in the Title. :::