Add attribute support (via 'annotation' directive) #97
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
Signed-off-by: Danila Fedorin <[email protected]>
Signed-off-by: Danila Fedorin <[email protected]>
1 task
lydia-duncan
approved these changes
Sep 5, 2024
DanilaFe
added a commit
to chapel-lang/chapel
that referenced
this pull request
Sep 5, 2024
Closes #23149. This PR implements my initial vision for documenting attributes based on procedures that implement them. In PR #25826, I made GPU attributes be backed by Chapel functions. One of my goals with this approach was to be able to document these attributes using the existing Chapel mechanism (doc comments attached to procedures). This PR does so, by adding a new chpldoc attribute (`@chpldoc.attributeSignature`) that marks a function as defining the signature (formals etc.) of an attribute. Since the functions in the GPU module that back attributes are internal (not intended to be called directly), they would normally be skipped by chpldoc's output. This PR adjusts the behavior of chpldoc to not skip the functions in this case. It also adds documentation to the various attributes using this new mechanism. This PR depends on chapel-lang/sphinxcontrib-chapeldomain#97, which implements the RST-to-HTML conversion of the new 'annotation' directive chpldoc will emit. <img width="725" alt="Screen Shot 2024-09-05 at 10 16 43 AM" src="https://github.com/user-attachments/assets/bcc3fbe8-301f-4727-ae92-be2968d4e0f4"> Reviewed by @e-kayrakli, @mppf, and @lydia-duncan -- thanks! ## Testing - [x] paratest (just in case)
DanilaFe
added a commit
to chapel-lang/chapel
that referenced
this pull request
Sep 18, 2024
This documents and makes use of the various changes I made in #25826, chapel-lang/sphinxcontrib-chapeldomain#97, and #25884. Reviewed by @e-kayrakli -- thanks!
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.
This PR adds an 'annotation' directive to our Sphinx integration which enables documenting attributes. In Sphinx, attributes are an existing concepts, which refer to what Chapel would call fields. As a result, the
attrdirective was taken, andattributeon top of that seemed confusing. @lydia-duncan suggested 'annotation' (perhaps in jest), but I think it's a pretty decent fallback.Another PR to chpldoc will be necessary to actually emit 'annotation' directives; it will not be part of this.
Reviewed by @lydia-duncan -- thanks!