From 0675f377d1ecd3d6ade470e3bdd7d78b249e7e4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Tue, 10 Jan 2017 15:34:41 -0500 Subject: [PATCH 1/2] Fix link syntax --- docs/profiles.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/profiles.rst b/docs/profiles.rst index 4ba0a5e8..f9056574 100644 --- a/docs/profiles.rst +++ b/docs/profiles.rst @@ -109,7 +109,7 @@ Documentation Warnings ...................... By default prospector will not produce warnings about missing documentation or -`docstring styleguide violations `. +`docstring styleguide violations `_. If you want to see these, use the `--doc-warnings` flag at runtime or include it in your profile:: @@ -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 ` +The strictness will turn on or off different messages generated by the `pep8.py `_ 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:: From 0749574df783457eb6168efb4157af36c10a2360 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C3=89ric=20Araujo?= Date: Sun, 22 Jan 2017 17:19:58 -0500 Subject: [PATCH 2/2] Use consistent code markup --- docs/profiles.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/profiles.rst b/docs/profiles.rst index f9056574..22bc26dc 100644 --- a/docs/profiles.rst +++ b/docs/profiles.rst @@ -110,19 +110,19 @@ Documentation Warnings By default prospector will not produce warnings about missing documentation or `docstring styleguide violations `_. -If you want to see these, use the `--doc-warnings` flag at runtime or include it in +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