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

Jump to bottom

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

Closed
vicuna opened this issue Jun 4, 2017 · 6 comments
Closed

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

vicuna opened this issue Jun 4, 2017 · 6 comments
Labels
documentation feature-wish newcomer-job

Comments

@vicuna
Copy link

vicuna 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
Copy link
Author

vicuna commented Feb 20, 2019

Comment author: lereena

I will work on this issue

@vicuna
Copy link
Author

vicuna commented Feb 27, 2019

Comment author: sshv

Can I work on this?

@vicuna
Copy link
Author

vicuna commented Feb 27, 2019

Comment author: lereena

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

@vicuna
Copy link
Author

vicuna commented Feb 27, 2019

Comment author: @gasche

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

@gasche
Copy link
Member

gasche 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).

@Octachron
Copy link
Member

Let's close the issue for now. We can open an issue for a format tutorial if the need arises.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation feature-wish newcomer-job
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@gasche @Octachron @vicuna