Skip to content

Commit

Permalink
docs: leave a note in status.json pointing to the right place to look
Browse files Browse the repository at this point in the history
In nedbat#1730 and
nedbat#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.
  • Loading branch information
nedbat committed Jan 15, 2024
1 parent 576cb3e commit 1a416b6
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions coverage/html.py
Expand Up @@ -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:
#
Expand Down Expand Up @@ -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,
Expand Down

0 comments on commit 1a416b6

Please sign in to comment.