Documented deprecation of quotes in favor of inline-quotes

Author: twolfson

README.rst

@@ -5,6 +5,10 @@ Flake8 Extension to lint for quotes.
    :target: https://travis-ci.org/zheller/flake8-quotes
    :alt: Build Status
 
+Deprecation notice in 0.3.0
+---------------------------
+To anticipate multiline support, we are renaming ``--quotes`` to ``--inline-quotes``. Please adjust your configurations appropriately.
+
 Usage
 -----
 
@@ -24,10 +28,10 @@ By default, we expect single quotes (') and look for unwanted double quotes (").
 
 .. code:: shell
 
-    flake8 --quotes '"'
+    flake8 --inline-quotes '"'
 
 or configuration option in `tox.ini`/`setup.cfg`.
 
 .. code:: ini
 
-    quotes = "
+    inline-quotes = "

flake8_quotes/__init__.py

@@ -1,4 +1,5 @@
 import tokenize
+import warnings
 
 import pep8
 
@@ -39,6 +40,9 @@ def add_options(cls, parser):
     @classmethod
     def parse_options(cls, options):
         if hasattr(options, 'quotes') and options.quotes is not None:
+            # https://docs.python.org/2/library/warnings.html#warnings.warn
+            warnings.warn('flake8-quotes has deprecated `quotes` in favor of `inline-quotes`. '
+                          'Please update your configugration')
             cls.inline_quotes = cls.INLINE_QUOTES[options.quotes]
         else:
             cls.inline_quotes = cls.INLINE_QUOTES[options.inline_quotes]