Bogdanp / Bogdanp/deta

Best way to document a schema?

Open
#18 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Racket
Stars
65
Forks
11
PR merge metrics
No merged PRs in 30d

Description

How would you go about writing Scribble docs for a `deta` schema? Use [`defstruct`](https://docs.racket-lang.org/scribble/doc-forms.html#%28form._%28%28lib._scribble%2Fmanual..rkt%29._defstruct%29%29) and add a caveat that it’s not actually a vanilla `struct`? Or just document the `make-` id function?

It would be neat if there was a `defschema` form for Scribble, but I can see why it might not be high on the list.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.