Fix halo workspace API docs and benchmark sample link#148
Merged
romerojosh merged 2 commits intoJun 30, 2026
Conversation
Signed-off-by: Minh Vu <vuhoangminh97@gmail.com>
fallintoplace
force-pushed
the
docs/fix-halo-workspace-docs
branch
from
8edbcfc to
1820fe2
Compare
romerojosh
approved these changes
Jun 29, 2026
romerojosh
left a comment
romerojosh
left a comment
Collaborator
There was a problem hiding this comment.
LGTM! Thanks for the edits @fallintoplace.
Collaborator
|
Can you fix the small |
Signed-off-by: Minh Vu <vuhoangminh97@gmail.com>
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
2 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.
Summary
cudecompGetHaloWorkspaceSizedocs so they describe halo workspace packing and staging instead of transpose workspace behaviorTransposeheadings and related prose typos in the C and Fortran API docsfacilitateanddocumentationtypos in the same API doc sections, including the Doxygen comments that feed the C API docsWhy
The Fortran halo workspace description appears to have been copied from the transpose workspace docs, so it describes the wrong operation. The benchmark README also linked to a non-existent
heatmap_scripts/samplespath, and the API reference had a few visible spelling mistakes that hurt searchability.