Commits

Adrian Sampson committed 37c326f

the: fix config syntax in docs

  • Participants
  • Parent commits 381dc75

Comments (0)

Files changed (1)

docs/plugins/the.rst

 but you can override these defaults to make more complex changes::
 
     the:
-        # handle The, default is on
-        the=yes
-        # handle A/An, default is on
-        a=yes
+        # handle "The" (on by default)
+        the: yes
+        # handle "A/An" (on by default)
+        a: yes
         # format string, {0} - part w/o article, {1} - article
         # spaces already trimmed from ends of both parts
         # default is '{0}, {1}'
-        format={0}, {1}
+        format: '{0}, {1}'
         # strip instead of moving to the end, default is off
-        strip=no
-        # custom regexp patterns, separated by space
-        patterns=
+        strip: no
+        # custom regexp patterns, space-separated
+        patterns: ...
 
 Custom patterns are case-insensitive regular expressions. Patterns can be
 matched anywhere in the string (not just the beginning), so use ``^`` if you