[OxCaml] Tutorial for library parameter#12111
Merged
shonfeder merged 10 commits intoocaml:mainfrom Jan 26, 2026
Merged
Conversation
maiste
added
docs
maiste
added
docs
maiste
force-pushed
the
doc/parameter-explanation
branch
from
5732b55 to
0106436
Compare
Sudha247
reviewed
Aug 27, 2025
| Parameterized library in Dune are a concept similar to | ||
| {doc}`/virtual-libraries`. Parameterized libraries are the formalization within | ||
| the compiler of virtual libraries.A parameterized library is conceptually | ||
| equivalent to a functor. For more detailled explanation, see (TODO @maiste: |
Collaborator
There was a problem hiding this comment.
Is it meant to link some documentation about parameterized libraries? Is it available somewhere?
Collaborator
|
@maiste is it ok if I push to this branch directly? |
Collaborator
Author
|
Yes it that exactly the purpose of this PR 😄 |
This was referenced Oct 13, 2025
Signed-off-by: Etienne Marais <dev@maiste.fr> Signed-off-by: Etienne Marais <self@maiste.fr>
Signed-off-by: Etienne Marais <self@maiste.fr>
Signed-off-by: Etienne Marais <self@maiste.fr>
Signed-off-by: Etienne Marais <self@maiste.fr>
Signed-off-by: Sudha Parimala <sudharg247@gmail.com>
art-w
force-pushed
the
doc/parameter-explanation
branch
from
24fb410 to
4a1cbd2
Compare
Signed-off-by: Arthur Wendling <arthur@tarides.com>
art-w
force-pushed
the
doc/parameter-explanation
branch
from
4a1cbd2 to
0462a91
Compare
Sudha247
added a commit
that referenced
this pull request
Dec 11, 2025
Closes #11652 Adds a tutorial for setting up an OxCaml project with Dune package management. I contemplated where this should go, and thought this might be a good place, after all. It shows (1) how to setup an OxCaml project, (2) servers as a live example of the previous two tutorials. #12111 is a more comprehensive tutorial about parametric libraries and OxCaml, but it doesn't specifically cover the topic of Dune package management with OxCaml. I recently ported an OxCaml project to build with Dune package management and the configuration was not as straightforward as I expected, and thought a tutorial on this topic might be useful. This takes some material from https://github.com/gridbugs/hello-oxcaml (thanks @gridbugs!). --------- Signed-off-by: Sudha Parimala <sudharg247@gmail.com>
jonludlam
pushed a commit
to jonludlam/dune
that referenced
this pull request
Jan 14, 2026
…#12780) Closes ocaml#11652 Adds a tutorial for setting up an OxCaml project with Dune package management. I contemplated where this should go, and thought this might be a good place, after all. It shows (1) how to setup an OxCaml project, (2) servers as a live example of the previous two tutorials. ocaml#12111 is a more comprehensive tutorial about parametric libraries and OxCaml, but it doesn't specifically cover the topic of Dune package management with OxCaml. I recently ported an OxCaml project to build with Dune package management and the configuration was not as straightforward as I expected, and thought a tutorial on this topic might be useful. This takes some material from https://github.com/gridbugs/hello-oxcaml (thanks @gridbugs!). --------- Signed-off-by: Sudha Parimala <sudharg247@gmail.com>
- clean up some syntax errors (dangling `::::`) - try to make expressions more precise and concise - add analogy example tables to each section, aiming ot help build on people's intuitions of ocaml Signed-off-by: Shon Feder <shon.feder@gmail.com>
shonfeder
force-pushed
the
doc/parameter-explanation
branch
from
5262169 to
45905d7
Compare
shonfeder
changed the title
Signed-off-by: Shon Feder <shon.feder@gmail.com>
Member
shonfeder
approved these changes
Jan 24, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR is ready for review.
The tutorial aims to follow a simple flow to go through all the possibilities provided by parameterized libraries. It covers the entire "diamond" of the parameterized library, i.e.:
The tutorial covers: