callProcess exception undocumented
Open
- Dominant language
- Haskell
- Stars
- 91
- Forks
- 91
- PR merge metrics
- No merged PRs in 30d
Description
The docs say that callProcess throws an exception when the process returns non-zero. It is not documented what type of exception this is and therefore this API is pretty much useless. Please consider documenting the exception type or adding a new API that returns the status code instead.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the callProcess API documentation and its implementation or related tests. Confirm the exception behavior and document the exception type, or clarify the supported status-code alternative; done means callers can identify how non-zero process exits are reported.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100