Add hint in warning about title spanning multiple lines (#1000)

r-lib · Mar 10, 2020 · e7433fc · e7433fc
1 parent e86cebf
commit e7433fc
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/NEWS.md b/NEWS.md
@@ -1,5 +1,8 @@
 # roxygen2 (development version)
 
+* The warning for section titles spanning multiple lines now includes the hint 
+  "Did you forget a colon (:) at the end of the title?" (@maelle, #994).
+
 * Can now document objects created with `delayedAssign()` by forcing
   evaluation at documentation time (#1041)
 

diff --git a/R/rd-section.R b/R/rd-section.R
@@ -9,7 +9,10 @@ roxy_tag_rd.roxy_tag_section <- function(x, base_path, env) {
   title <- str_split(pieces[1], "\n")[[1]]
 
   if (length(title) > 1) {
-    roxy_tag_warning(x, "Section title spans multiple lines")
+    roxy_tag_warning(x, paste0(
+      "Section title spans multiple lines.\n",
+      "Did you forget a colon (:) at the end of the title?"
+    ))
     return()
   }