0003468: Sys_error documentation

View Issue Details [ Jump to Notes ]

[ Issue History ] [ Print ]

Project

Category

View Status

Date Submitted

Last Update

0003468

OCaml

OCaml documentation

public

2005-02-15 23:28

2012-09-11 09:44

Reporter

administrator

Assigned To

Priority

normal

Severity

minor

Reproducibility

always

Status

acknowledged

Resolution

open

Platform

OS Version

Product Version

Target Version

4.00.2+dev

Fixed in Version

Summary

0003468: Sys_error documentation

Description

Full_Name: Didier Remy
Version: 3.08
OS:
Submission from: quincy.inria.fr (128.93.8.52)

Sys_error est je pense très mal documentée.
Dans Core Library, il est correctement dit:

        Exception raised by the input/output functions to report an
        operating system error.

Mais dans Pervasives, la plupart des fonctions qui peuvent la lever
(output_*, etc.) ne le disent pas. C'est d'autant plus trompeur que certaines
le disent (open_*, close_*) ce qui sugèrerait que seules celles-ci peuvent
effectivement la lever.

Par ailleurs, c'est à la limite de l'erreur de documentation de faire
[Index of exceptions]

        http://caml.inria.fr/ocaml/htmlman/libref/index_exceptions.html [^]

et de ne pas trouver Sys_error et toutes les autres exceptions qui sont
primitives! (Pour la même raison, on peut vérifier qu'on ne trouve pas le
type int dans index of types, etc.) J'en comprends bien la raison, mais
l'utilisateur lambda aura du mal à la comprendre... et une fois comprise à
accepter l'explication.

Amicalement,

        Didier

Tags

No tags attached.

Attached Files

Relationships

Notes
There are no notes attached to this issue.

Issue History
Date Modified	Username	Field	Change
2005-11-18 10:14	administrator	New Issue
2005-12-15 15:29	doligez	Priority	normal => low
2005-12-15 15:29	doligez	Category	OCaml general => OCaml documentation
2005-12-15 15:29	doligez	Description Updated
2012-07-11 17:28	doligez	Priority	low => normal
2012-07-11 17:28	doligez	Target Version	=> 4.01.0+dev
2012-07-31 13:37	doligez	Target Version	4.01.0+dev => 4.00.1+dev
2012-09-11 09:44	doligez	Target Version	4.00.1+dev => 4.00.2+dev