#175 - Add documentation for quote differences (#334)

PyCQA · Oct 14, 2018 · 6dc6fea · 6dc6fea
1 parent d873260
commit 6dc6fea
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/docs/snippets/cli.rst b/docs/snippets/cli.rst
@@ -30,6 +30,11 @@ Usage
                             regular expression; default is --ignore-decorators=''
                             which does not ignore any decorated functions.
 
+      Note:
+        When using --match, --match-dir or --ignore-decorators consider
+        whether you should use a single quote (') or a double quote ("),
+        depending on your OS, Shell, etc.
+
       Error Check Options:
         Only one of --select, --ignore or --convention can be specified. If
         none is specified, defaults to `--convention=pep257`. These three

diff --git a/src/pydocstyle/config.py b/src/pydocstyle/config.py
@@ -574,6 +574,13 @@ def _create_option_parser(cls):
         option('--config', metavar='<path>', default=None,
                help='use given config file and disable config discovery')
 
+        parser.add_option_group(OptionGroup(
+            parser,
+            'Note',
+            'When using --match, --match-dir or --ignore-decorators consider '
+            'whether you should use a single quote (\') or a double quote ("), '
+            'depending on your OS, Shell, etc.'))
+
         check_group = OptionGroup(
             parser,
             'Error Check Options',
@@ -632,6 +639,7 @@ def _create_option_parser(cls):
                      "regular expression; default is --ignore-decorators='{0}'"
                      " which does not ignore any decorated functions."
                      .format(cls.DEFAULT_IGNORE_DECORATORS_RE)))
+
         return parser