Skip to content

[GLUON] Docstrings for public functions #7323

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 27, 2025
Merged

[GLUON] Docstrings for public functions #7323

merged 5 commits into from
Jun 27, 2025

Conversation

pawelszczerbuk
Copy link
Contributor

Adding documentation for public gluon API. Generated by codex, with proof-reading and editing some of the issues by me. Formatting differs from triton docstrings, (using Google style rather than reST), but subjectively this seems more readable. Changing to reST formatting should be relatively easy if people have strong opinions about this.

Copy link
Contributor

@peterbell10 peterbell10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems reasonable, a few comments though.

Comment on lines 201 to 206
Args:
handle (ir.Value): The IR value representing the allocation handle.
element_ty (dtype): The data type of each element.
shape (List[int]): The dimensions of the descriptor.
layout (SharedLayout): The layout of the shared memory.
alloc_shape (List[int]): The actual allocation shape.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the __init__ is not part of the public API, we probably don't want the arguments documented here.

@pawelszczerbuk
Copy link
Contributor Author

Thanks for taking the time @peterbell10 !

@peterbell10 peterbell10 enabled auto-merge (squash) June 27, 2025 15:04
@peterbell10 peterbell10 merged commit cf80141 into main Jun 27, 2025
9 checks passed
@peterbell10 peterbell10 deleted the pawel/gluon_doc branch June 27, 2025 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants