summaryrefslogtreecommitdiff
path: root/coverage/plugin.py
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2018-02-24 07:45:54 -0500
committerNed Batchelder <ned@nedbatchelder.com>2018-02-24 07:45:54 -0500
commit6fbe4f09334060e1f89d4d9a7aab2cfae40f26d8 (patch)
treee9b0fc54f0911b17f5ef4d917e6f299b9163f6f2 /coverage/plugin.py
parentedf8ff449138ce039e2a1445cab89b53d2333aa3 (diff)
downloadpython-coveragepy-git-6fbe4f09334060e1f89d4d9a7aab2cfae40f26d8.tar.gz
Missed a detail of file_reporter in the docs
Diffstat (limited to 'coverage/plugin.py')
-rw-r--r--coverage/plugin.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/coverage/plugin.py b/coverage/plugin.py
index db7ca0a7..415246ab 100644
--- a/coverage/plugin.py
+++ b/coverage/plugin.py
@@ -134,7 +134,8 @@ class CoveragePlugin(object):
This will only be invoked if `filename` returns non-None from
:meth:`file_tracer`. It's an error to return None from this method.
- Returns a :class:`FileReporter` object to use to report on `filename`.
+ Returns a :class:`FileReporter` object to use to report on `filename`,
+ or the string `"python"` to have coverage.py treat the file as Python.
"""
_needs_to_implement(self, "file_reporter")