summaryrefslogtreecommitdiff
path: root/doc
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
commit3449f99bd3cafcca08c619bc9aeacf198a873a27 (patch)
treea22067830468a84d3e83a818d0a3909b4d273118 /doc
parent67fa5659b668542d4814246cc5e4a4a115778964 (diff)
downloadpython-coveragepy-3449f99bd3cafcca08c619bc9aeacf198a873a27.tar.gz
More plugin doc tweaks
Diffstat (limited to 'doc')
-rw-r--r--doc/plugins.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/plugins.rst b/doc/plugins.rst
index d8f4ef5..1fc5c10 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::