Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before, docs were a builtin part of the metadata, and added like so:
This generally made the metadata harder to consume.
Now, the docs are not specialized at all. They're simply another codec factory:
This codec factory is designed such that the resultant codec has both the metadata of
$.documented
and the metadata corresponding to the original$foo
. This means thatCodecVisitor
s will ignore$.documented
by default:However, you can explicitly opt-in to using
$.documented
:This
$.documented
can be written entirely in user-land (in contrast to the last approach), but we include it here for standardization. However, users can write similar codec factories if they'd like to attach other miscellaneous metadata.Resolves #136