From 342e7da2941ae5291f1a94b6ad66ce489f6985fe Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Sat, 13 Nov 2021 19:00:51 -0500 Subject: docs: document the exceptions ... and make some of them private. --- coverage/exceptions.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'coverage/exceptions.py') diff --git a/coverage/exceptions.py b/coverage/exceptions.py index 6631e1ad..de2257a1 100644 --- a/coverage/exceptions.py +++ b/coverage/exceptions.py @@ -4,12 +4,12 @@ """Exceptions coverage.py can raise.""" -class BaseCoverageException(Exception): +class _BaseCoverageException(Exception): """The base of all Coverage exceptions.""" pass -class CoverageException(BaseCoverageException): +class CoverageException(_BaseCoverageException): """An exception raised by a coverage.py function.""" pass @@ -29,7 +29,7 @@ class NotPython(CoverageException): pass -class ExceptionDuringRun(CoverageException): +class _ExceptionDuringRun(CoverageException): """An exception happened while running customer code. Construct it with three arguments, the values from `sys.exc_info`. @@ -38,7 +38,7 @@ class ExceptionDuringRun(CoverageException): pass -class StopEverything(BaseCoverageException): +class _StopEverything(_BaseCoverageException): """An exception that means everything should stop. The CoverageTest class converts these to SkipTest, so that when running -- cgit v1.2.1