Skip to content

Commit e8c9b5c

Browse files
committed
Change report column heading text in preparation for move to board aliases
In the near future, board aliases will be supported in addition to FQBN. "Board" describes either well, while "FQBN" does not apply to board aliases.
1 parent fe7a62f commit e8c9b5c

File tree

2 files changed

+10
-10
lines changed

2 files changed

+10
-10
lines changed

reportsizedeltas.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ def generate_report(self, sketches_reports):
275275
Keyword arguments:
276276
sketches_reports -- list of sketches_reports containing the data to generate the deltas report from
277277
"""
278-
fqbn_column_heading = "FQBN"
278+
fqbn_column_heading = "Board"
279279

280280
# Generate summary report data
281281
summary_report_data = [[fqbn_column_heading]]

tests/test_reportsizedeltas.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -573,23 +573,23 @@ def test_generate_report():
573573
sketches_report_path = test_data_path.joinpath("size-deltas-reports-new")
574574
expected_deltas_report = (
575575
"**Memory usage change @ d8fd302**\n\n"
576-
"FQBN|flash|RAM for global variables\n"
576+
"Board|flash|RAM for global variables\n"
577577
"-|-|-\n"
578578
"arduino:avr:leonardo|:green_heart: -12 - -12|0 - 0\n"
579579
"arduino:avr:uno|:green_heart: -994 - -994|:green_heart: -175 - -175\n\n"
580580
"<details>\n"
581581
"<summary>Click for full report table</summary>\n\n"
582-
"FQBN|examples/Bar<br>flash|examples/Bar<br>RAM for global variables|examples/Foo<br>flash|examples/Foo<br>RAM "
583-
"for global variables\n"
582+
"Board|examples/Bar<br>flash|examples/Bar<br>RAM for global variables|examples/Foo<br>flash|examples/Foo<br>"
583+
"RAM for global variables\n"
584584
"-|-|-|-|-\n"
585585
"arduino:avr:leonardo|N/A|N/A|-12|0\n"
586586
"arduino:avr:uno|N/A|N/A|-994|-175\n\n"
587587
"</details>\n\n"
588588
"<details>\n"
589589
"<summary>Click for full report CSV</summary>\n\n"
590590
"```\n"
591-
"FQBN,examples/Bar<br>flash,examples/Bar<br>RAM for global variables,examples/Foo<br>flash,examples/Foo<br>RAM "
592-
"for global variables\n"
591+
"Board,examples/Bar<br>flash,examples/Bar<br>RAM for global variables,examples/Foo<br>flash,examples/Foo<br>"
592+
"RAM for global variables\n"
593593
"arduino:avr:leonardo,N/A,N/A,-12,0\n"
594594
"arduino:avr:uno,N/A,N/A,-994,-175\n"
595595
"```\n"
@@ -804,11 +804,11 @@ def test_get_summary_value(minimum, maximum, expected_value):
804804

805805
def test_generate_markdown_table():
806806
assert reportsizedeltas.generate_markdown_table(
807-
row_list=[["FQBN", "Flash", "RAM"], ["foo:bar:baz", 42, 11]]
808-
) == "FQBN|Flash|RAM\n-|-|-\nfoo:bar:baz|42|11\n"
807+
row_list=[["Board", "Flash", "RAM"], ["foo:bar:baz", 42, 11]]
808+
) == "Board|Flash|RAM\n-|-|-\nfoo:bar:baz|42|11\n"
809809

810810

811811
def test_generate_csv_table():
812-
assert reportsizedeltas.generate_csv_table(row_list=[["FQBN", "Flash", "RAM"], ["foo:bar:baz", 42, 11]]) == (
813-
"FQBN,Flash,RAM\nfoo:bar:baz,42,11\n"
812+
assert reportsizedeltas.generate_csv_table(row_list=[["Board", "Flash", "RAM"], ["foo:bar:baz", 42, 11]]) == (
813+
"Board,Flash,RAM\nfoo:bar:baz,42,11\n"
814814
)

0 commit comments

Comments
 (0)