summaryrefslogtreecommitdiff
path: root/doc/plugins.rst
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2015-01-25 14:52:37 -0500
committerNed Batchelder <ned@nedbatchelder.com>2015-01-25 14:52:37 -0500
commitee5004ff51d1f86b01fff56ae867f39790c3f98f (patch)
treec7b6ccb2e48fc2333e712f994c914e580e0534e6 /doc/plugins.rst
parent9b391506e516f439171fd95cfaec82df83440194 (diff)
downloadpython-coveragepy-git-ee5004ff51d1f86b01fff56ae867f39790c3f98f.tar.gz
More plugin doc tweaks
Diffstat (limited to 'doc/plugins.rst')
-rw-r--r--doc/plugins.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/plugins.rst b/doc/plugins.rst
index d8f4ef56..1fc5c10d 100644
--- a/doc/plugins.rst
+++ b/doc/plugins.rst
@@ -28,6 +28,16 @@ example, let's say you want to use one called fred_plugin.
plugins =
fred_plugin
+#. If the plugin needs its own configuration, you can add those settings in
+ the .coveragerc file in a section named for the plugin::
+
+ [fred_plugin]
+ option1 = True
+ option2 = abc.foo
+
+ Check the documentation for the plugin to see if it takes any options, and
+ what they are.
+
#. Run your tests as you usually would. NOTE: You will see a warning when
coverage starts::