CP-307947: [maintenance]: add .mli files to all database modules #6460
Conversation
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
Used 'dune format-dune-file dune >dune && mv dune.tmp dune' No functional change. Signed-off-by: Edwin Török <edwin.torok@cloud.com>
ocaml-lsp-server's 'Action->Infer interface' was used for this, and then removed internal/unused entries. Having an mli file is useful: * can find dead code more easily if it is clear which functions are internal to a module and which aren't * the impact of refactoring changes is more obvious (did we have to change an mli at all?) * makes it easier to understand what a module does There are some .ml files which only contain types, these are instead renamed to .mli and dune's `modules_without_implementation` feature is used. Executables get an empty .mli (recent versions of dune already do the equivalent of this, but this makes it more obvious). Drop code from .ml files that now show up as unused. Signed-off-by: Edwin Török <edwin.torok@cloud.com>
lindig
approved these changes
May 9, 2025
Vincent-lau
approved these changes
May 9, 2025
andyhhp
reviewed
May 9, 2025
Comment on lines
41
to
-43
| (* Write out a string *) | ||
| let string (output : Xmlm.output) (key : string) (x : string) = | ||
| pair output key x |
There was a problem hiding this comment.
You want to drop this comment too
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.
ocaml-lsp-server's 'Action->Infer interface' was used for this, and then removed internal/unused entries.
Having an mli file is useful:
There are some .ml files which only contain types, these are instead renamed to .mli and dune's
modules_without_implementationfeature is used.Executables get an empty .mli (recent versions of dune already do the equivalent of this, but this makes it more obvious).
Drop code from .ml files that now show up as unused.
Eventually we can also add some documentation, this will be done in followup PRs for new code.