Add docstring and attribute support to interfaces #25825
Merged
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: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
jabraham17
added a commit
to chapel-lang/sphinxcontrib-chapeldomain
that referenced
this pull request
Aug 28, 2024
Adds support for `interface`, which will be outputed by chpldoc after chapel-lang/chapel#25825 [Reviewed by @lydia-duncan]
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
Signed-off-by: Jade Abraham <[email protected]>
lydia-duncan
approved these changes
Aug 28, 2024
Signed-off-by: Jade Abraham <[email protected]>
DanilaFe
approved these changes
Aug 28, 2024
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.
Adds compiler support for interfaces to have attributes applied to them and have docstrings recognized by chpldoc
Resolves #17383
Relies on chapel-lang/sphinxcontrib-chapeldomain#95
This PR also updates the interface
Allocators.allocator. #25821 will update the existing Sort module allocators. No other allocators are currently shown in our documentationWhile adding tests of
@unstablewith interfaces, I found that some tests weren't actually testing what we thought they were (i.e.test/unstable-keyword/enum_test1.chpl), so I updated themTesting
[Reviewed by @lydia-duncan and @DanilaFe]