Adding the Title Case issue #33
Conversation
website/description_issues.qmd
Outdated
| ``` | ||
|
|
||
| ::: 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 was a problem hiding this comment.
One important thing I would add as exeception: package and function names. Since R is case sensitive package names should be spelled with the correct case and in single quotes in the title.
e.g.: One should not write 'Ggplot2' in the title even if it is wrapped in single quotes.
However, I don't know if tool::toTitleCase() ignores words in single quotes thus solving this problem on the fly.
There was a problem hiding this comment.
I think tools::toTitleCase doesn't treat a package name specially
In addition, according to writing R extensions (WRE) one must not name the package on the title (and it would be weird to name other packages in the title of your package):
Do not repeat the package name: it is often used prefixed by the name. Refer to other packages and external software in single quotes, and to book titles (and similar) in double quotes.
Maybe it is worth adding a link to that section of WRE.
First pass at writing the Title Case issue 🎉
hrlines to be longerstringrbut I wonder if this is more widely used thantools::toTitleCase()