De-duplicate signatues in {index,search}.mli #186
Merged
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
craigfe
force-pushed
the
deduplicate-module-types
branch
from
5528504 to
9212d6f
Compare
craigfe
commented
Jun 25, 2020
Comment on lines
-80
to
-81
| module Entry = Entry | ||
| module Array = Array |
There was a problem hiding this comment.
Tiny code change here. We don't need to create these modules in the struct since we used destructive substitution in the return type.
craigfe
commented
Jun 25, 2020
Comment on lines
+168
to
+173
| module type Key = sig | ||
| (* N.B. We use [sig ... end] redirections to avoid linking to the [_intf] | ||
| file in the generated docs. Once Odoc 2 is released, this can be | ||
| removed. *) | ||
|
|
||
| include Key | ||
| (** @inline *) | ||
| end |
There was a problem hiding this comment.
Here's the gymnastics in question. It's sufficient to do:
module type Key = Keybut then Odoc will add an extra link indirection through the _intf file: not a great UX.
craigfe
force-pushed
the
deduplicate-module-types
branch
from
9212d6f to
76c728f
Compare
pascutto
approved these changes
Jun 26, 2020
craigfe
force-pushed
the
deduplicate-module-types
branch
2 times, most recently
from
d213f6f to
29eb2e5
Compare
craigfe
force-pushed
the
deduplicate-module-types
branch
from
29eb2e5 to
fbb75e3
Compare
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.
Pure refactor; no behavioural changes. Create some
_intffiles to avoid duplicating large module types in.{ml,mli}pairs. We need to do some gymnastics to avoid linking to those files in the docs (but once ocaml/odoc#439 is released we won't need to do even that).Depends on #185, for no particular reason other than my own laziness...