This repository was archived by the owner on Feb 20, 2026. It is now read-only.
docs: Add descriptions to more of the parameters#1342
Merged
kevkim-codes merged 16 commits intomainfrom Oct 28, 2024
Merged
Conversation
|
Warning: This pull request is touching the following templated files:
|
…into 372734275-add-descriptions-to-all-parameters-2
cindy-peng
approved these changes
Oct 25, 2024
kevkim-codes
approved these changes
Oct 28, 2024
This file contains hidden or 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
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Summary:
This PR adds more descriptions for more method parameters. It is a follow-up to this other PR which has a summary that explains the problem this PR is solving in detail.
ie. In the screenshot below in the table, the description should be something like
EntityFilter[] A filter for entitiesand not justEntityFilter[].Next Steps:
A few more classes need descriptions for their method parameters.