Documenting struct in Scribble

Questions & Answers
,
1

How do you document a field of a struct which has a #:mutable option. There is nothing about this in the documentation. I'm running racket 8.7.

2

Looks like this is not documented but available:

Source code: https://github.com/racket/games/blob/eba5c6fa54c524871badb8b0e205fe37640d6c3e/cards/cards.scrbl#L60

@defstruct[region ([x real?]
                   ...
                   [(callback #:mutable)
                    (or/c #f (if button?
                                 (-> any)
                                 (-> (listof (is-a?/c card<%>)) any)))]
                   ...

Rendered: https://docs.racket-lang.org/cards/index.html#(def._((lib._games%2Fcards..rkt)._region))

1 Like
3

PR opened for the doc edits.