search

rstudio / rmarkdown

Dynamic Documents for R
https://rmarkdown.rstudio.com
GNU General Public License v3.0
2.88k stars 975 forks source link

`rmarkdown::draft()` has incorrect documentation for `template.yaml` #2329

Open AshesITR opened 2 years ago

AshesITR commented 2 years ago

Code and documentation mismatch regarding the template YAML: description is a required field (as per code) but is never mentioned in the documentation.

https://github.com/rstudio/rmarkdown/blob/6fc53d89826491100c77f7790169f8afd629907c/R/draft.R#L34-L39

https://github.com/rstudio/rmarkdown/blob/6fc53d89826491100c77f7790169f8afd629907c/R/draft.R#L83-L85

cderv commented 2 years ago

Thanks for the report. We'll amend the doc.