Skip to content

Update future tense testing in docs

Marcel Amirault requested to merge docs-test-regex into master

What does this MR do?

This adds regex rules to the future tense docs test. With this update, the test now returns more useful error messages. It also detects errors across line breaks in most cases.

Previously, error messages looked like:

 user/todos.md
 61:68    error  Avoid using future tense:       gitlab.FutureTense 
                 "will be"                                          
 92:29    error  Avoid using future tense:       gitlab.FutureTense 
                 "will"                                             
 109:160  error  Avoid using future tense:       gitlab.FutureTense 
                 "will"                                             
 115:93   error  Avoid using future tense:       gitlab.FutureTense 
                 "will"                                             
 118:39   error  Avoid using future tense:       gitlab.FutureTense 
                 "will"

After, they show the verb which makes it easier to find and understand what needs to be fixed.

 user/todos.md
 61:68    error  Avoid using future tense:       gitlab.FutureTense 
                 "will be"                                          
 92:29    error  Avoid using future tense:       gitlab.FutureTense 
                 "will mark"                                        
 109:160  error  Avoid using future tense:       gitlab.FutureTense 
                 "will remain"                                      
 115:93   error  Avoid using future tense:       gitlab.FutureTense 
                 "will only"                                        
 118:39   error  Avoid using future tense:       gitlab.FutureTense 
                 "will disappear"

Merge request reports