From fd43e3509f559c55b61f92dacbd524cd42941b06 Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 11 Apr 2020 14:19:18 -0400 Subject: =?UTF-8?q?Finish=20up=20#967.=20Thanks,=20Bern=C3=A1t=20G=C3=A1bo?= =?UTF-8?q?r?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- coverage/control.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'coverage/control.py') diff --git a/coverage/control.py b/coverage/control.py index f7db26e9..2b8c3d26 100644 --- a/coverage/control.py +++ b/coverage/control.py @@ -367,7 +367,11 @@ class Coverage(object): option name. For example, the ``branch`` option in the ``[run]`` section of the config file would be indicated with `"run:branch"`. - Returns the value of the option. + Returns the value of the option. The type depends on the option + selected. + + As a special case, an `option_name` of ``"paths"`` will return an + OrderedDict with the entire ``[paths]`` section value. .. versionadded:: 4.0 @@ -394,6 +398,9 @@ class Coverage(object): [run] branch = True + As a special case, an `option_name` of ``"paths"`` will replace the + entire ``[paths]`` section. The value should be an OrderedDict. + .. versionadded:: 4.0 """ -- cgit v1.2.1