docs: Document move and move! functions #617
Merged
Conversation
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
This commit adds documentation for the `move` and `move!` functions. - `move` (3-argument) is documented in `docs/src/data-management.md`. This section explains its role in data movement for task arguments, including `Chunk` unwrapping, and notes that custom implementations are usually unnecessary. - `move!` (5-argument) is documented in `docs/src/datadeps.md`. This section explains its use in Datadeps for in-place operations, how it handles `Chunk`s, and when custom implementations might be needed (though often not for `AbstractArray` types supporting `copyto!`).
This commit corrects the function signatures for `Dagger.move` and `Dagger.move!` in the documentation and adds illustrative examples for custom implementations. - `Dagger.move(from_proc::Dagger.Processor, to_proc::Dagger.Processor, x)` signature updated in `data-management.md`. - `Dagger.move!(dep_mod, from_space::Dagger.MemorySpace, to_space::Dagger.MemorySpace, from, to)` signature updated in `datadeps.md`. - Examples for both functions demonstrate how users might define custom data movement logic for their types.
jpsamaroo
commented
Jun 23, 2025
jpsamaroo
commented
Jun 23, 2025
jpsamaroo
commented
Jun 23, 2025
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.
From jules.google.com