feat: add code examples for properties #435
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
iliapolo
requested changes
Sep 12, 2021
5 tasks
iliapolo
requested changes
Sep 13, 2021
iliapolo
approved these changes
Sep 13, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add code examples for all properties within "Properties" sections. This does not add code examples for parameters (e.g. for fields in constructors or methods).
Even though the code examples include the types of the properties, we cannot remove the "Type: xxx" labels below them because they may include links to other types, and code snippets cannot include links in GitHub markdown. (We can probably work around this for the Construct Hub by using the JSON format instead).
Resolves #436