Warn on reference to ambiguous label #781
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
jonludlam
force-pushed
the
ambiguous-ref-warning
branch
from
d0d815b to
c99c8d8
Compare
Julow
approved these changes
Nov 22, 2021
src/xref2/env.ml
Outdated
| | ([ x ] as results), Some c -> ( | ||
| record_lookup_results env results; | ||
| match c env x with | ||
| | Some (`Ambiguous (x, y)) -> Result.Error (`Ambiguous (x, y)) |
There was a problem hiding this comment.
Suggested change
| | Some (`Ambiguous (x, y)) -> Result.Error (`Ambiguous (x, y)) | |
| | Some (`Ambiguous _ as e) -> Result.Error e |
src/xref2/ref_tools.ml
Outdated
| let ambiguous_warning name (results : [< Component.Element.any ] list) = | ||
| let results = (results :> Component.Element.any list) in | ||
| if List.for_all (function `Label _ -> true | _ -> false) results then | ||
| ambiguous_label_warning name (results :> [> Component.Element.any ] list) |
There was a problem hiding this comment.
Ah yes! thanks, this was left in from when I was trying to return a different `AmbiguousLabel error (which ultimately failed, predictably in hindsight).
| in | ||
|
|
||
| Identifier.Maps.Label.add identifier err env.ambiguous_labels | ||
| | Some _ -> assert false |
There was a problem hiding this comment.
To avoid this assert, we could use lookup_by_id s_label, which also return useful data in the ambiguous case.
There was a problem hiding this comment.
I think this assert is in place of what I actually want, which is a type error. You're right, we could avoid this assert with s_label, but s_label just does:
(function #Component.Element.label as r -> Some r | _ -> None)
so I could get the same effect by having just Some _ -> env.ambiguous_labels. I don't like we've got a runtime instead of a compile time error here, but I like ignoring the error entirely even less :-)
We already warn when defining an explicit label that conflicts with another, but this PR adds a warning when trying to reference a label that is ambiguous.
jonludlam
force-pushed
the
ambiguous-ref-warning
branch
from
0473bf0 to
6c40226
Compare
jonludlam
added a commit
to jonludlam/opam-repository
that referenced
this pull request
Nov 26, 2021
CHANGES: Bugs fixed - Man page renderer fails to output pages that have children (@jonludlam, @Julow, ocaml/odoc#766) - Fix resolution of unprefixed references to pages (@Julow, ocaml/odoc#755) - Fix reporting of ambiguous labels (@Julow, @jonludlam, ocaml/odoc#773, ocaml/odoc#781) - Allow referencing of labels in the top comment (@jonludlam, ocaml/odoc#771) Additions - Strip unquoted spaces in identifiers for a more flexible reference syntax (@lubega-simon, @panglesd, ocaml/odoc#783) - Add context to messages raised in expansions of includes (@Julow, ocaml/odoc#780)
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.
We already warn when defining an explicit label that conflicts with another,
but this PR adds a warning when trying to reference a label that is ambiguous.