Add/fix/shorten/refresh module index descriptions #25773
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
Here, I focused on modules I obviously own, key distributions that were lacking a description, and entries that took up multiple lines. --- Signed-off-by: Brad Chamberlain <[email protected]>
1 task
--- Signed-off-by: Brad Chamberlain <[email protected]>
--- Signed-off-by: Brad Chamberlain <[email protected]>
…ule-index-fixes
--- Signed-off-by: Brad Chamberlain <[email protected]>
lydia-duncan
approved these changes
Aug 23, 2024
--- Signed-off-by: Brad Chamberlain <[email protected]>
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 adds and updates module index description comments in support of #25667. Here, I focused on modules I obviously own, key distributions that were lacking a description, and entries that took up multiple lines:
In order to add documentation for the block and cyclic distributions, I had to add an explicit
modulekeyword. This flipped it from a prototype module to a production module, popping us into Chapel's stricter error-handling mode. As a result, I had to add some newthrowsdeclarations to dsiSerialRead/Write routines to make them pass. Happily, since these are internal routines, it is not a breaking change. (I also removed a commented out and redundant dsiSerialWrite routine in CyclicDist.chpl).Adding the
modulekeyword (but not doing any other reformatting), I broke our CI's linting of the file and didn't want to wrestle with fixing the indentation here. As a result, I applied the new attribute added by Daniel in #25800 to keep things working for the time being.