doc: Update generator function documentation #398
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
facebook-github-bot
added
the
CLA Signed
JasonKChow
requested changes
Oct 10, 2024
| @@ -57,7 +57,7 @@ def gen( | |||
| Args: | |||
There was a problem hiding this comment.
Add type hint for return
| @@ -80,7 +80,7 @@ def gen( | |||
| num_points (int, optional): Number of points to query. | |||
There was a problem hiding this comment.
add type hint for return
| @@ -55,7 +55,8 @@ def gen( | |||
| Args: | |||
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.
Update the return type documentation on all generator functions from np.ndarray to torch.Tensor. Additionally, document cases where the returned tensor shape may change.