Improve JSON reader documentation #1559
Merged
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.
Which issue does this PR close?
re #1538
Rationale for this change
I found @tustvold 's comment helpful #1539 (review) and it wasn't 100% clear to me previously why there was a split between
Decoder
andReader
. While it was fresh on my mind, I tried to update the doc strings to encode this knowledge for the futureWhat changes are included in this PR?
Improve doc comments
Are there any user-facing changes?
Better (hopefully) doc strings