Docsweeper

=======================

Incompatible Changes
--------------------

- drop :ref:`command line option <cmdline_spec>` ``--vcs-shim``. Is replaced by command line
option ``-vcs``.
- drop enabling Flake8 plugin with the option string ``--enable-extensions=DOC100``
Upgrading from Docsweeper v1.x
------------------------------

- Replace usage of command line option ``--vcs-shim`` with ``--vcs``. Parameter
signature of ``--vcs`` option is unchanged from ``--vcs-shim``.
- Replace usage of ``DOC100`` to enable Flake8 plugin with ``docsweeper``

==============================

Deprecations
------------

- deprecate enabling Flake8 Plugin with option ``--enable-extensions=DOC100``

New Features
------------

- enabling Flake8 Plugin with option ``--enable-extensions=docsweeper``

Bugfixes
--------

- fix crash when following renames using mercurial version control systems
- fix crash of Flake8 plugin when it was invoked with no version control system chosen

==============================

Bugfixes
--------

- fix bug introduced in v1.2.1 that caused crash if input file was not
parseable at some point in version control history

Miscellaneous
-------------
- improve error messages for CLI users

==============================

Miscellaneous
-------------
- fix rst rendering error in changelog

==============================

Bugfixes
--------

- fix Windows build

==============================

Dependencies
------------

- drop dependency on ``typing_extensions`` for Python 3.7

Miscellaneous
-------------

- improve error handling