Skip to content

Commit 6bf5102

Browse files
committed
doc: promote version-awareness
- print the current version, or rather the version that built these docs - add note imploring people to report the version they are working with
1 parent a51b1c7 commit 6bf5102

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

scribblings/gtp-benchmarks.scrbl

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
gtp-benchmarks/scribblings/util
55
scriblib/figure
66
scribble/example
7+
(only-in setup/getinfo get-info)
78
(for-label
89
require-typed-check
910
racket/base
@@ -15,15 +16,27 @@
1516
(only-in require-typed-check/logging require-typed-check-logger)
1617
(only-in typed/racket/base require/typed))]
1718

19+
@(define (package-version)
20+
(define v-str ((get-info '("gtp-benchmarks")) 'version))
21+
(unless (string? v-str)
22+
(raise-argument-error 'gtp-benchmarks "valid-version?" v-str))
23+
v-str)
24+
25+
@; -----------------------------------------------------------------------------
26+
1827
@title{GTP Benchmarks}
1928

2029
GTP = gradual typing performance
2130

31+
Latest Version: @hyperlink["https://github.com/bennn/gtp-benchmarks/releases"]{@package-version[]}
32+
2233
Source: @url{https://github.com/bennn/gtp-benchmarks}
2334

2435
This package contains benchmarks for measuring the cost of typed/untyped
2536
interaction in Typed Racket.
2637

38+
@bold{Always include a version number when reporting data on these benchmarks.}
39+
2740
@section[#:tag "gtp:api"]{Running a benchmark}
2841

2942
To run a benchmark:

0 commit comments

Comments
 (0)