Branch: refs/heads/main
Revision: 1d63f67
Author: lydia-duncan
Link: Add throws documentation to 3 subprocess methods by lydia-duncan · Pull Request #18588 · chapel-lang/chapel · GitHub
Log Message:
Merge pull request #18588 from lydia-duncan/spawnThrows
Add throws documentation to 3 subprocess methods
[reviewed by @daviditen]
subprocess.poll, subprocess.wait and subprocess.communicate all
are declared as throwing functions, but didn't provide documentation of
what errors they throw. Providing such documentation is useful for users
so that they know what to catch to recover from potential issues.
Some of the SystemError subclasses that can be thrown by these
methods would only occur if we'd done something wrong in setting the
subprocess up in some way, meaning that it isn't reasonable to expect
the user to be able to recover from them. I've not gone into detail on
those errors in the documentation output (and to some extent wonder
if we should be throwing them), but I do call the list of them out in some
cases. Others are errors that the user could respond to by restarting the
subprocess in some way or making the call again, and these I have called
out in more detail.
Makes progress on #12162, but does not complete it (as it took a while to
track down the errors for these methods)
The documentation built with these changes as expected and looked good.
Modified Files:
M modules/standard/Spawn.chpl
Compare: https://github.com/chapel-lang/chapel/compare/b7518ac1bc17...1d63f675d439