Skip to content

Commit

Permalink
Merge pull request #201 from merwok-forks/patch-1
Browse files Browse the repository at this point in the history
Fix link syntax
  • Loading branch information
carlio committed Mar 8, 2017
2 parents a5606a9 + 0749574 commit c893531
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions docs/profiles.rst
Original file line number Diff line number Diff line change
Expand Up @@ -109,20 +109,20 @@ Documentation Warnings
......................

By default prospector will not produce warnings about missing documentation or
`docstring styleguide violations <https://www.python.org/dev/peps/pep-0257/>`.
If you want to see these, use the `--doc-warnings` flag at runtime or include it in
`docstring styleguide violations <https://www.python.org/dev/peps/pep-0257/>`_.
If you want to see these, use the ``--doc-warnings`` flag at runtime or include it in
your profile::

doc-warnings: true

This will turn on the otherwise disabled `pep257` tool.
This will turn on the otherwise disabled ``pep257`` tool.


Test Warnings
.............

Prospector will not inspect unit tests and test files by default. You can
turn this on using the `--test-warnings` flag or in your profile::
turn this on using the ``--test-warnings`` flag or in your profile::

test-warnings: true

Expand All @@ -141,7 +141,7 @@ but you can turn it on using the ``--member-warnings`` flag or in a profile::
PEP8 Control
............

The strictness will turn on or off different messages generated by the `pep8.py <https://pypi.python.org/pypi/pep8>`
The strictness will turn on or off different messages generated by the `pep8.py <https://pypi.python.org/pypi/pep8>`_
tool depending on how picky they are. However, if you want to have the standard 'medium' strictness but get either
complete or zero pep8 style warnings, you can use a shorthand like below::

Expand Down

0 comments on commit c893531

Please sign in to comment.