summaryrefslogtreecommitdiff
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
commit95d2570cca83d20e7b31695ffbc61da63c7ee0e9 (patch)
treef92f69f155de6032bad590b596ae0c1c044749e9
parent917c250a9afb2d9d7675131974ff3dbec5bf355e (diff)
downloadpython-coveragepy-95d2570cca83d20e7b31695ffbc61da63c7ee0e9.tar.gz
Missed a detail of file_reporter in the docs
-rw-r--r--coverage/plugin.py3
1 files changed, 2 insertions, 1 deletions
diff --git a/coverage/plugin.py b/coverage/plugin.py
index db7ca0a..415246a 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")