Add missing :throws: doc tags in package modules
#27440
Open
Conversation
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
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
As well as making a :throws: on FileSystem.exists more specific Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
Signed-off-by: Anna Rift <anna.rift@hpe.com>
arifthpe
force-pushed
the
add-throws-doc-tags
branch
from
1a1e47f to
22efac7
Compare
dlongnecke-cray
approved these changes
Jun 26, 2025
| @@ -831,7 +835,12 @@ used to recursively hold tables and respective values | |||
| } | |||
|
|
|||
|
|
|||
| /* Write a Table to channel f in TOML format */ | |||
| /* | |||
| Write a Table to channel f in TOML format | |||
There was a problem hiding this comment.
nit: period to match the style of the above comment
| @@ -1121,7 +1132,11 @@ module TomlReader { | |||
|
|
|||
| config const debugTomlReader = false; | |||
|
|
|||
| /* Returns the next token in the current line without removing it */ | |||
| /* | |||
| Returns the next token in the current line without removing it | |||
There was a problem hiding this comment.
nit: period to match the style of the first added comment
| @@ -1274,7 +1289,11 @@ module TomlReader { | |||
| } | |||
|
|
|||
|
|
|||
| /* retrieves next token in currentLine */ | |||
| /* | |||
| Retrieves next token in currentLine | |||
There was a problem hiding this comment.
nit: period to match the style of the first added comment
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.
Add missing
:throws:docs tags to procedures in these package modules:BuffersCryptoCurlHDF5HDFSLinearAlgebraRecordParserTOMLUsed the list from #11417 plus just grepping for
throws, and excluded no-doc procs.ZMQwas on the list but not modified as it wasn't missing any tags.Contributes to #11417.
[reviewer info placeholder]
Testing: