Add a few docstrings for public functions#363
Merged
Conversation
|
|
||
| Create an uninitialized array on the device with the specified type and size. | ||
| """ | ||
| array(x::AbstractArray) = to_device(x) |
Collaborator
There was a problem hiding this comment.
We probably need a separate docstring for this method since it is semantically distinct from the others.
PhilipFackler
approved these changes
May 26, 2026
PhilipFackler
left a comment
PhilipFackler
left a comment
Collaborator
There was a problem hiding this comment.
Thank you. This is a good start and a welcome reminder that we need to add docstrings (and exports) for all of our API functions.
williamfgc
reviewed
May 29, 2026
|
|
||
| public zeros, ones, fill | ||
| public to_device, to_host, transfer! | ||
| public @parallel_for, @parallel_reduce |
Collaborator
There was a problem hiding this comment.
Minor, we also use parallel_reduce as convenience functions , e.g., JACC.parallel_reduce(x) sums all the elements of x. This is a great start!
Contributor
Author
There was a problem hiding this comment.
parallel_reduce is already exported above, which implies public usually.
Collaborator
There was a problem hiding this comment.
My bad. Thanks for catching it!
williamfgc
approved these changes
May 29, 2026
Collaborator
|
Test this please |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #355