From 1a416b678695531c0131065e5dc9cc621a47ed5f Mon Sep 17 00:00:00 2001 From: Ned Batchelder Date: Mon, 15 Jan 2024 09:02:36 -0500 Subject: [PATCH] docs: leave a note in status.json pointing to the right place to look In https://github.com/nedbat/coveragepy/issues/1730 and https://github.com/nedbat/coveragepy/issues/1732, it's clear that people might poke around and find apparently useful information in the htmlcov/status.json file. Add a note to try to get them to the place they want to be. --- coverage/html.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/coverage/html.py b/coverage/html.py index 7b827a794..5a571dac0 100644 --- a/coverage/html.py +++ b/coverage/html.py @@ -506,6 +506,11 @@ class IncrementalChecker: STATUS_FILE = "status.json" STATUS_FORMAT = 2 + NOTE = ( + "This file is an internal implementation detail to speed up HTML report" + + " generation. Its format can change at any time. You might be looking" + + " for the JSON report: https://coverage.rtfd.io/cmd.html#cmd-json" + ) # The data looks like: # @@ -578,6 +583,7 @@ def write(self) -> None: files[filename] = fileinfo status = { + "note": self.NOTE, "format": self.STATUS_FORMAT, "version": coverage.__version__, "globals": self.globals,