DocExample.
One example on a page, rendered in each language from one source and validated against its type
Figure 1DocExamplespecified
- kind
- value
- scope
- none
- key
- none
- store
- none
- family
- documentation
Fields#
| field | type | required | note |
|---|---|---|---|
language | one of curl | typescript | python | rust | json | sql | yes | |
code | text | yes | |
validates_against | text | yes | a type of the register |
Routes that use it#
No route takes or returns DocExample directly. The record holds it, and the objects that point at it reach it.