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

printf or format example in the tutorial part of the manual #7548

Open
vicuna opened this issue Jun 4, 2017 · 5 comments

Comments

Projects
None yet
2 participants
@vicuna
Copy link

commented Jun 4, 2017

Original bug ID: 7548
Reporter: @Octachron
Status: acknowledged (set by @Octachron on 2017-07-11T19:45:06Z)
Resolution: open
Priority: low
Severity: feature
Category: documentation
Tags: manual, junior_job
Monitored by: @gasche

Bug description

Currently, the tutorial part of the manual takes some time to describe the pretty printing of symbolic expressions at http://caml.inria.fr/pub/docs/manual-ocaml/coreexamples.html#sec15 . However, this example uses neither the "Printf" nor the "Format" module. Since pretty printing is a major use of both modules and "Printf" and "Format" relies on a potentially surprising feature of OCaml, it would be nice to extend the existing example with a version using either "Printf" or "Format".

@vicuna

This comment has been minimized.

Copy link
Author

commented Feb 20, 2019

Comment author: lereena

I will work on this issue

@vicuna

This comment has been minimized.

Copy link
Author

commented Feb 27, 2019

Comment author: sshv

Can I work on this?

@vicuna

This comment has been minimized.

Copy link
Author

commented Feb 27, 2019

Comment author: lereena

@sshv I have already completed it, you should choose another issue

@vicuna

This comment has been minimized.

Copy link
Author

commented Feb 27, 2019

Comment author: @gasche

@Lereena's proposed patch is undergoing review at
#2272

@gasche

This comment has been minimized.

Copy link
Member

commented Mar 16, 2019

#2272 has now been merged: we have a nice explanation of Printf in the manual. I'll leave this issue open to track the idea of also having a presentation of Format, but personally I'm not sure it belongs to the "tutorial" part of the manual, as Format is sensibly more specialized. I would rather have a nice documentation at the beginning of the Format module (so at the beginning of format.mli).

@vicuna vicuna added the feature-wish label Mar 20, 2019

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.