docs: improve usage guide for selective readers #1406
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.
Some users (including me) tend to read only code blocks that contains actual code (and not data structures).
Thus it is easily missed that
User
is a custom/example data-structure that we defined ourselves.This PR adds a tiny hint to the first code example, so it becomes clear that
User
is a example data-structure even if you read only that example.I also considered adding the hint to all examples, but that code block is more or less the entry point so it should be sufficient to add it there.
Ref: Discord User Question