docs: Consistent captioning in articles #1134
Conversation
| @@ -14,9 +14,7 @@ editor_options: | |||
| source("setup/setup.R") | |||
| `````` | |||
|
|
|||
| ## Introduction | |||
There was a problem hiding this comment.
Removing this section header to be consistent with most of the other vignettes that don't have it.
| @@ -16,8 +16,6 @@ editor_options: | |||
| source("setup/setup.R") | |||
| `````` | |||
|
|
|||
| ## Introduction {#intro} | |||
There was a problem hiding this comment.
Removing this section header to be consistent with most of the other vignettes that don't have it.
| @@ -15,9 +15,7 @@ editor_options: | |||
| source("setup/setup.R") | |||
| `````` | |||
|
|
|||
| # Building data models from data frames with {dm} | |||
There was a problem hiding this comment.
To be consistent with all the other vignettes.
| @@ -4,7 +4,7 @@ date: "`r Sys.Date()`" | |||
| output: rmarkdown::html_vignette | |||
| vignette: > | |||
| %\VignetteEncoding{UTF-8} | |||
| %\VignetteIndexEntry{First read: Getting started with dm} | |||
There was a problem hiding this comment.
All changes to vignette index entry are made to avoid the following warning:
#> Warning message:
#> The vignette title specified in \VignetteIndexEntry{} is different from the title in the YAML metadata.
There was a problem hiding this comment.
This was intentional so that the vignettes still look okay-ish on https://cran.r-project.org/package=dm .
There was a problem hiding this comment.
There is
options(rmarkdown.html_vignette.check_title = FALSE)There was a problem hiding this comment.
I mean "there is" in the sense that it could be used here
There was a problem hiding this comment.
In that case, can we instead change the vignette titles to be consistent with the vignette index entries on CRAN?
That way, it will look good on CRAN, and there won't be any warnings.
| @@ -4,7 +4,7 @@ date: "`r Sys.Date()`" | |||
| output: rmarkdown::html_vignette | |||
| vignette: > | |||
| %\VignetteEncoding{UTF-8} | |||
| %\VignetteIndexEntry{First read: Getting started with dm} | |||
There was a problem hiding this comment.
This was intentional so that the vignettes still look okay-ish on https://cran.r-project.org/package=dm .
@krlmlr In that case, can we instead change the vignette titles to be consistent with the vignette index entries on CRAN? That way, it will look good on CRAN, and there won't be any warnings. |
|
Can we please decouple the discussion about the vignette titles from consistent captioning (the focus of this pull request)? |
|
Okay, sounds good. I will handle these two things in separate PRs. |
|
Yeah, let's not spend too much time on these warnings, and discuss first. |
|
Superseded by #1157 |
Closes #435