Skip to content

Commit ae44bad

Browse files
committed
scriblib/footnote: advertise 'next instead of #t as #:number for note
1 parent 390d671 commit ae44bad

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

scribble-doc/scriblib/scribblings/footnote.scrbl

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@
88

99
@defmodule[scriblib/footnote]
1010

11-
@defparam[note-number number (or/c integer? boolean?)]{
11+
@defparam[note-number number (or/c integer? #f 'next)]{
1212
This parameter controls the number of footnotes in the HTML renderer.
1313
See @racket[note] for how it is interpreted.
1414

1515
To enable footnote numbers in HTML,
16-
add @racket[#:number #t] to your first call to @racket[note]
16+
add @racket[#:number 'next] to your first call to @racket[note]
1717
(you can also add it to subsequent calls, but that is not necessary);
18-
or set this parameter to either 1 or @racket[#t].
18+
or set this parameter to either 1 or @racket['next].
1919
To disable footnote numbers again in HTML,
2020
set this parameter back to @racket[#f] (the default).
2121

@@ -29,9 +29,9 @@ Creates a margin note for HTML and a footnote for Latex/PDF output.
2929

3030
If rendering HTML, then the number parameter is used, which default to @racket[(note-number)].
3131
If it is @racket[#f] then no number is used (default / legacy behavior).
32-
If it is @racket[#t] and @racket[(note-number)] is an integer,
32+
If it is @racket['next] and @racket[(note-number)] is an integer,
3333
then the latter value is used.
34-
If it is @racket[#t] and @racket[(note-number)] is not integer,
34+
If it is @racket['next] and @racket[(note-number)] is not integer,
3535
then the value 1 will be used instead.
3636
If it is an integer, then its value is used.
3737
If an integer value is used, then @racket[(note-number)] is set to the next integer.

0 commit comments

Comments
 (0)