Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Omitted information concerning exceptions that could be raised. #6168

Closed
vicuna opened this Issue Sep 10, 2013 · 2 comments

Comments

Projects
None yet
1 participant
@vicuna
Copy link
Collaborator

vicuna commented Sep 10, 2013

Original bug ID: 6168
Reporter: kosik
Status: closed (set by @damiendoligez on 2014-05-25T18:14:07Z)
Resolution: fixed
Priority: low
Severity: trivial
Version: 4.00.0
Fixed in version: 4.02.0+dev
Category: documentation
Tags: junior_job
Duplicate of: #5841

Bug description

Unix.stat function may raise Unix.Unix_error exception.

Like in case of Unix.execv and others, it would be beneficial to state it also explicitely in case of Unix.stat function.

(If that is the intended documenting policy concerning exceptions.)

Additional information

I've reported similar problem before:
#5841
(for openfile)

There may be more of these kind of omissions.

@vicuna

This comment has been minimized.

Copy link
Collaborator Author

vicuna commented Sep 10, 2013

Comment author: @xavierleroy

Any single function from the Unix module can raise Unix_error if the underlying system call fails. There is no point in mentioning it for every single function.

The documentation for the Unix module says:

"exception Unix_error of error * string * string

Raised by the system calls below when an error is encountered. [...]"

If this is not clear enough, we should make it clearer that any of the Unix functions can raise Unix_error. But please don't submit one bug report per Unix function.

@vicuna

This comment has been minimized.

Copy link
Collaborator Author

vicuna commented May 25, 2014

Comment author: @damiendoligez

fixed in branch 4.02 (commit 14918)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.