jsonschema: improve doc (#122)
Improve the package documentation. Add a README and LICENSE, anticipating the relocation of this package to its own module elsewhere.
This commit is contained in:
parent
78a66a438a
commit
0f596bde17
1 changed files with 106 additions and 18 deletions
|
|
@ -34,12 +34,13 @@ import (
|
|||
// types, as they are incompatible with the JSON schema spec.
|
||||
// - maps with key other than 'string'
|
||||
// - function types
|
||||
// - channel types
|
||||
// - complex numbers
|
||||
// - unsafe pointers
|
||||
//
|
||||
// It will return an error if there is a cycle in the types.
|
||||
//
|
||||
// For recognizes struct field tags named "jsonschema".
|
||||
// This function recognizes struct field tags named "jsonschema".
|
||||
// A jsonschema tag on a field is used as the description for the corresponding property.
|
||||
// For future compatibility, descriptions must not start with "WORD=", where WORD is a
|
||||
// sequence of non-whitespace characters.
|
||||
|
|
|
|||
Loading…
Reference in a new issue