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
Streams documentation #3606
Comments
Comment author: administrator From: marc.herbert.1@ml.free.fr
There is (fortunately) only one kind of streams in ocaml. Jacques |
Comment author: administrator
As I understand it, there is only one kind of streams, at least at the type
What was removed from ocaml is only the special syntax for streams. Library Jacques |
Comment author: administrator This is the Postfix program at host ml.free.fr. I'm sorry to have to inform you that the message returned For further assistance, please send mail to If you do so, please include this problem report. You can
marc.herbert.1@ml.free.fr: unknown user: "marc.herbert.1" Reporting-MTA: dns; ml.free.fr Final-Recipient: rfc822; marc.herbert.1@ml.free.fr Received: from nez-perce.inria.fr (nez-perce.inria.fr [192.93.2.78])
As I understand it, there is only one kind of streams, at least at the type
What was removed from ocaml is only the special syntax for streams. Library Jacques |
Comment author: administrator JG (2005-07-13) |
Original bug ID: 3606
Reporter: administrator
Status: closed
Resolution: fixed
Priority: normal
Severity: minor
Category: ~DO NOT USE (was: OCaml general)
Monitored by: marc
Bug description
Full_Name: Marc Herbert
Version: 3.08.2
OS: linux
Submission from: lns-vlq-38-lyo-82-253-128-116.adsl.proxad.net (82.253.128.116)
This is (again :-) a complaint about the manual. It makes no comment
about ocaml/ocamlp4 design choices.
There seems to be two different kind of streams. I write "there
seems" because I find the documentation concerning streams confusing
so I am not even sure. The only hint about this is in section 20.32:
"Warning: these functions create streams with fast access; it is
illegal to mix them with streams built with [< >];".
On the other hand, section 7.2 states: "Streams and stream parsers are
no longer part of the Objective Caml language but available through a
Camlp4 syntax extension." (no more word about different kind of streams
here). Later on in the "standard library" chapter there is section
20.32 intitled "Stream and parsers"?! Huh, so the "standard library"
is now part of ocamlp4 ?
And don't forget the third beast, the "mixed" streams of section 20.32.
Probably the result of some undocumented genetic experience...
I think the ocaml documentation about streams should be much much
clarified (ocamlp4 documentation looks fine at first sight). To begin,
why have two different objects with the (almost, depending on where
you are in the manual) same name? This is IMHO the original sin. So
when other sections of the manual (like 20.11 Genlex, 20-16 Lexing)
talk about "streams", it is hard for the newcomer to guess what it is
all about. No surprise people file bugs like bug #235 and #1284.
Maybe the manual could explain once for all the difference between
"FA-streams" and "[<>]-streams", and precise which one is meant at
each occurence in the manual?
The text was updated successfully, but these errors were encountered: