Skip to content

Conversation

@maiste
Copy link
Collaborator

@maiste maiste commented Aug 1, 2025

This PR is not ready for review. It is a way to share with @art-w the advancement regarding the documentation of library_parameter.

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.:

    parameter
   /         \
implement   parameterized
   \         /
    instance

Right now, the PR covers:

  • Setting up a project
  • Writing a parameter
  • Writing the implementation of the parameter

The remaining part are:

  • Writing a parameterized library
  • Instantiate a parameterized library

The rest of the work is subject to modification as it is currently the first draft.

@maiste maiste added docs Documentation improvements oxcaml Related to the support to OxCaml functionnalities labels Aug 1, 2025
@maiste maiste added docs Documentation improvements oxcaml Related to the support to OxCaml functionnalities labels Aug 1, 2025
maiste and others added 4 commits August 1, 2025 16:53
Signed-off-by: Etienne Marais <[email protected]>
Signed-off-by: Etienne Marais <[email protected]>
Signed-off-by: Etienne Marais <[email protected]>
Signed-off-by: Etienne Marais <[email protected]>
Signed-off-by: Etienne Marais <[email protected]>
@maiste maiste force-pushed the doc/parameter-explanation branch from 5732b55 to 0106436 Compare August 1, 2025 14:53
@shonfeder shonfeder self-assigned this Aug 5, 2025
Copy link
Collaborator

@Sudha247 Sudha247 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm reading through this with the intention of taking it over from @maiste (thanks for all the hard work!). Leaving some notes below.

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:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it meant to link some documentation about parameterized libraries? Is it available somewhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes 👍🏻

@Sudha247
Copy link
Collaborator

@maiste is it ok if I push to this branch directly?

@maiste
Copy link
Collaborator Author

maiste commented Aug 28, 2025

Yes it that exactly the purpose of this PR 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation improvements oxcaml Related to the support to OxCaml functionnalities

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants