Skip to content

Commit

Permalink
Changelog/docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
carljm committed May 16, 2020
1 parent 47f4237 commit 3e6f16c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 8 deletions.
5 changes: 5 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ Changelog
master
------

* Require ``libcst>=0.3.5``.

* Add ``--ignore-existing-annotations`` flag to ``apply`` command.


20.4.2
------

Expand Down
12 changes: 4 additions & 8 deletions doc/generation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,17 +91,13 @@ Both ``monkeytype stub`` and ``monkeytype apply`` accept the following options:

Don't apply your configured :ref:`rewriters` to the output types.

Additionally, ``monkeytype stub`` accepts:

.. option:: --ignore-existing-annotations

Generate a stub based only on traced calls, ignoring any existing type
annotations in the code. (By default, existing annotations in the code take
precedence over traced types.) This can be useful for validating the
correctness of existing annotations.
Generate a stub based only on traced calls, ignoring (and overwriting, if
applying stubs) any existing type annotations in the code. (By default,
existing annotations in the code take precedence over traced types.)

This option is not usable with ``monkeytype apply``, since it would
frequently result in a conflict when attempting to apply annotations.
Additionally, ``monkeytype stub`` accepts:

.. option:: --omit-existing-annotations

Expand Down

0 comments on commit 3e6f16c

Please sign in to comment.