Merge pull request #79 from tobyhodges/patch-1

more verbose validation errors

DESCRIPTION

@@ -1,12 +1,17 @@
 Package: pegboard
 Title: Explore and Manipulate Markdown Curricula from the Carpentries
-Version: 0.2.0
-Authors@R:
+Version: 0.2.1
+Authors@R:c(
     person(given = "Zhian N.",
            family = "Kamvar",
            role = c("aut", "cre"),
-           email = "zkamvar@gmail.com",
-           comment = c(ORCID = "0000-0003-1458-7108"))
+           email = "zkamvar@carpentries.org",
+           comment = c(ORCID = "0000-0003-1458-7108")),
+    person(given = "Toby",
+           family = "Hodges",
+           role = c("ctb"),
+           email = "tobyhodges@carpentries.org"),
+    person())
 Description: The Carpentries (<https://carpentries.org>) curricula is made of of
     lessons that are hosted as websites. Each lesson represents between a half
     day to two days of instruction and contains several episodes, which are

NEWS.md

@@ -1,3 +1,9 @@
+# pegboard 0.2.1
+
+## MISC
+
+ - The inline messages for link validation errors are more verbose (@tobyhodges, #79)
+
 # pegboard 0.2.0
 
 ## NEW FEATURES

R/validate_links.R

@@ -202,9 +202,9 @@ link_tests <- c(
   internal_file = "[missing file] {orig}",
   internal_well_formed = "[incorrect formatting]: [{text}][{orig}] -> [{text}]({orig})",
   all_reachable = "",
-  img_alt_text  = "[missing alt-text]",
-  descriptive   = "[uninformative text] {sQuote(text)}",
-  link_length   = "[text too short] {sQuote(text)}",
+  img_alt_text  = "[image missing alt-text]",
+  descriptive   = "[uninformative link text] {sQuote(text)}",
+  link_length   = "[link text too short] {sQuote(text)}",
   NULL
 )
 

tests/testthat/_snaps/Lesson.md

@@ -155,8 +155,8 @@
       - Images need alt-text <https://webaim.org/techniques/hypertext/link_text#alt_link>
       
       ::warning file=_episodes/14-looping-data-sets.md,line=191:: [missing file] ../no-workie.svg
-      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [missing alt-text]
-      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [image missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [image missing alt-text]
 
 # Lessons can be validated [ansi]
 
@@ -237,8 +237,8 @@
       - Images need alt-text <https://webaim.org/techniques/hypertext/link_text#alt_link>
       
       ::warning file=_episodes/14-looping-data-sets.md,line=191:: [missing file] ../no-workie.svg
-      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [missing alt-text]
-      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [image missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [image missing alt-text]
 
 # Lessons can be validated [unicode]
 
@@ -319,8 +319,8 @@
       - Images need alt-text <https://webaim.org/techniques/hypertext/link_text#alt_link>
       
       ::warning file=_episodes/14-looping-data-sets.md,line=191:: [missing file] ../no-workie.svg
-      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [missing alt-text]
-      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [image missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [image missing alt-text]
 
 # Lessons can be validated [fancy]
 
@@ -401,6 +401,6 @@
       - Images need alt-text <https://webaim.org/techniques/hypertext/link_text#alt_link>
       
       ::warning file=_episodes/14-looping-data-sets.md,line=191:: [missing file] ../no-workie.svg
-      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [missing alt-text]
-      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=195:: [image missing alt-text]
+      ::warning file=_episodes/14-looping-data-sets.md,line=197:: [missing file] ../no-workie.svg [image missing alt-text]