Skip to content

Commit 4badec5

Browse files
committed
[doc] Standardise capitalisation of "Hjson" in testplan.py
Signed-off-by: Rupert Swarbrick <rswarbrick@lowrisc.org>
1 parent be17a76 commit 4badec5

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

src/dvsim/testplan.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ class Element:
6565
def __init__(self, raw_dict) -> None:
6666
"""Initialize the testplan element.
6767
68-
raw_dict is the dictionary parsed from the HJSon file.
68+
raw_dict is the dictionary parsed from the Hjson file.
6969
"""
7070
# 'tags' is an optional field in addition to the mandatory self.fields.
7171
self.tags = []
@@ -261,7 +261,7 @@ class Testplan:
261261

262262
@staticmethod
263263
def _parse_hjson(filename):
264-
"""Parses an input file with HJson and returns a dict."""
264+
"""Parses an input file with Hjson and returns a dict."""
265265
try:
266266
return hjson.load(Path(filename).open())
267267
except OSError:
@@ -275,7 +275,7 @@ def _create_testplan_elements(kind: str, raw_dicts_list: list, tags: set) -> lis
275275
"""Create testplan elements from the list of raw dicts.
276276
277277
kind is either 'testpoint' or 'covergroup'.
278-
raw_dicts_list is a list of dictionaries extracted from the HJson file.
278+
raw_dicts_list is a list of dictionaries extracted from the Hjson file.
279279
"""
280280
items = []
281281
item_names = set()
@@ -314,13 +314,13 @@ def _get_percentage(value, total) -> str:
314314
def __init__(self, filename, repo_top=None, name=None) -> None:
315315
"""Initialize the testplan.
316316
317-
filename is the HJson file that captures the testplan. It may be
317+
filename is the Hjson file that captures the testplan. It may be
318318
suffixed with tags separated with a colon delimiter to filter the
319319
testpoints. For example: path/too/foo_testplan.hjson:bar:baz
320320
repo_top is an optional argument indicating the path to top level repo
321321
/ project directory. It is used with filename arg.
322322
name is an optional argument indicating the name of the testplan / DUT.
323-
It overrides the name set in the testplan HJson.
323+
It overrides the name set in the testplan Hjson.
324324
"""
325325
self.name = None
326326
self.testpoints = []
@@ -408,7 +408,7 @@ def _parse_testplan(self, filename: Path, tags: set, repo_top=None) -> None:
408408
It creates the list of testpoints and covergroups extracted from the
409409
file.
410410
411-
filename is the path to the testplan file written in HJson format.
411+
filename is the path to the testplan file written in Hjson format.
412412
repo_top is an optional argument indicating the path to repo top.
413413
"""
414414
if repo_top is None:
@@ -451,7 +451,7 @@ def _parse_testplan(self, filename: Path, tags: set, repo_top=None) -> None:
451451
if not testpoints and not covergroups:
452452
sys.exit(1)
453453

454-
# Any variable in the testplan that is not a recognized HJson field can
454+
# Any variable in the testplan that is not a recognized Hjson field can
455455
# be used as a substitution variable.
456456
substitutions = {k: v for k, v in obj.items() if k not in self.rsvd_keywords}
457457
for tp in self.testpoints:
@@ -472,11 +472,11 @@ def get_stage_regressions(self):
472472
if tp.stage in tp.stages[1:]:
473473
regressions[tp.stage].update({t for t in tp.tests if t})
474474

475-
# Build regressions dict into a hjson like data structure
475+
# Build regressions dict into a Hjson-like data structure
476476
return [{"name": ms, "tests": list(regressions[ms])} for ms in regressions]
477477

478478
def write_testplan_doc(self, output: TextIO) -> None:
479-
"""Write testplan documentation in markdown from the hjson testplan."""
479+
"""Write testplan documentation in markdown from the Hjson testplan."""
480480
stages = {}
481481
for tp in self.testpoints:
482482
stages.setdefault(tp.stage, []).append(tp)

0 commit comments

Comments
 (0)