Skip to content

Commit

Permalink
Doc tweaks.
Browse files Browse the repository at this point in the history
  • Loading branch information
carljm committed Dec 14, 2017
1 parent ffe17a9 commit c49ef17
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ annotations directly to your code::
Requirements
------------

MonkeyType requires Python 3.6+ and the `retype`_ library (for applying
type stubs to code files).
MonkeyType requires Python 3.6+ and the `retype`_ library (for applying type
stubs to code files). It generates only Python 3 type annotations (no type
comments).

Installing
----------
Expand Down
5 changes: 3 additions & 2 deletions doc/tracing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,9 @@ script under MonkeyType tracing using ``monkeytype run`` at the command line::

$ monkeytype run myscript.py

``monkeytype run`` accepts the same :option:`monkeytype -c` option to point
MonkeyType to the config it should use.
``monkeytype run`` accepts the same :option:`monkeytype -c` option as
``monkeytype stub`` and ``monkeytype apply``, to point MonkeyType to the config
it should use.

.. module:: monkeytype

Expand Down

0 comments on commit c49ef17

Please sign in to comment.