update functors.md with minor tweaks #2984
Open
Conversation
This file contains 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
jakubsvec001
force-pushed
the
update_functors_md
branch
from
b62c04e to
4c84091
Compare
jakubsvec001
force-pushed
the
update_functors_md
branch
from
4c84091 to
d057ce0
Compare
cuihtlauac
reviewed
Feb 26, 2025
| In the example above, `t` from `with type` takes precedence over the local `t`, which only has a local scope. Don't shadow names too often because it makes the code harder to understand. | ||
| In the example above, `t` from `with type` takes precedence over the local `t`, which only has a local scope. | ||
|
|
||
| **Warning**: Don't shadow names too often because it makes the code harder to understand. |
cuihtlauac
requested changes
Feb 26, 2025
There was a problem hiding this comment.
Thanks @jakubsvec001. This is nice, only minor edits proposed.
|
|
||
| **Note**: An OCaml interface file (`.mli`) must be a module, not a functor. Functors must be embedded inside modules. Therefore, it is customary to call them `Make`. | ||
| **Note**: While an OCaml interface file (`.mli`) is a module, an interface file is not allowed to be a functor. Functors must be embedded inside modules. Therefore, it is customary to call them `Make`. <!-- I find this confusing; is "Make" a synononym for OCaml functors? -Jakub --> |
There was a problem hiding this comment.
Suggested change
| **Note**: While an OCaml interface file (`.mli`) is a module, an interface file is not allowed to be a functor. Functors must be embedded inside modules. Therefore, it is customary to call them `Make`. <!-- I find this confusing; is "Make" a synononym for OCaml functors? -Jakub --> | |
| **Note**: An OCaml file (`.ml`) defines a module, not a functor. Functors must be embedded inside modules. It is customary to call the functor `Make`. This allows writing `module IntSet = Set.Make(Int)`. |
You're right; the initial text was confusing and wrong. Thanks for pointing this. Do you think the code module IntSet = Set.Make(Int) needs to be explained?
bbatsov
reviewed
Mar 2, 2025
| @@ -330,7 +330,7 @@ Check the program's behaviour using `opam exec -- dune exec funkt < dune`. | |||
|
|
|||
| [Dependency injection](https://en.wikipedia.org/wiki/Dependency_injection) is a way to parametrise over a dependency. | |||
|
|
|||
| Here is a refactoring of the module `IterPrint` to use this technique: | |||
| Here is a refactoring of the module `IterPrint` to use dependency injection: | |||
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Small tweaks for clarity.
This pull request has an embedded question about the meaning of the
line 354:
Note: While an OCaml interface file (
.mli) is a module, an interface file is not allowed to be a functor. Functors must be embedded inside modules. Therefore, it is customary to call themMake.