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:
Jonathan Amsterdam 2025-07-11 11:27:33 -04:00 • committed by GitHub
commit 0f596bde17
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -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.