Skip to content

Commit e3ecaa8

Browse files
committed
docs(examples): correct the deck's class javadoc alongside its slides
The class javadoc carried the same stale instruction the slides did - refresh data and provenance "on the release commit" for a 2.0 asset, two releases after 2.0 shipped - and it also described the scaling iteration metadata as missing from a "historical file" rather than as covering only one tier, which is what the format actually does. It now says what the slides say: read the ratios rather than the timings, because both libraries are measured in the same run and their proportions survive a change of machine while the milliseconds do not.
1 parent 84ed1a2 commit e3ecaa8

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

examples/src/main/java/com/demcha/examples/flagships/EngineDeckV2Example.java

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,9 +66,11 @@
6666
* <p>Benchmark wording is intentionally conservative. The bundled JSON is a
6767
* dated single-machine reference run without hardware or commit provenance;
6868
* allocation values are average thread-allocated MiB per render, not peak
69-
* heap, and scaling iteration metadata is absent from the historical file.
70-
* A final 2.0 release asset should refresh both data and provenance on the
71-
* release commit.</p>
69+
* heap, and scaling iteration metadata covers only the small-invoice tier.
70+
* Read the ratios rather than the timings: both libraries are measured in the
71+
* same run, so their proportions survive a change of machine while the
72+
* milliseconds do not. Refresh the data file and these figures together — see
73+
* {@code docs/operations/benchmarks.md}.</p>
7274
*
7375
* @author Artem Demchyshyn
7476
* @since 2.0.0

0 commit comments

Comments
 (0)