correct usage example #716
Open
+3
−4
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
Signed-off-by: lubegasimon <[email protected]>
Signed-off-by: lubegasimon <[email protected]>
jonludlam
reviewed
Sep 3, 2021
| utop # open Odoc_xref2;; | ||
| utop # open Odoc_xref_test;; | ||
| utop # let test_data = "module type M = sig type t end module N : M type u = N.t";; | ||
| utop # let id, docs, sg = Common.model_of_string test_data;; | ||
| utop # let id, sg, docs = Common.model_of_string test_data;; |
There was a problem hiding this comment.
I think the last value in this triple is now the optional 'canonical' value - model_of_string ends up calling read_interface:
let read_interface root name intf =
let id = `Root (root, Odoc_model.Names.ModuleName.make_std name) in
let sg, canonical =
read_signature Odoc_model.Semantics.Expect_canonical Env.empty id intf
in
(id, sg, (canonical :> Odoc_model.Paths.Path.Module.t option))There was a problem hiding this comment.
Indeed, so we probably need to rename the variable from docs to canonical. (Sorry for the delay to respond)
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.
correct usage example in
test/xref2/lib/common.cppo.ml