Add docs for group property on bodies #82
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
Having a doc comment on the getter will have priority over the docs provided in the BodyOptions interface
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.
This addresses #80 .
The documentation on the property has been kept short with links to other explanations. The example from #80 has been added to the
canInteractfunction. A link to this function has been made from the group property to get more context of how the property is used internally.The example will have to be kept up to date manually if the code changes, but since the functionality if already defined this is unlikely to happen.
I have intentionally not ran the pre-commit script as there seems to be code formatted with other setting currently committed. This touches almost every file and I did not want to add that.
Sorry for the long wait and lack of communication since I brough this up, but here it is.