Resolve path references to modules #1164
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
The code for resolving path-references is factorized into the 'lookup_path' function. The 'Named_roots' for libraries is used to locate modules. Env's API is changed to make the Ref_tools part easier to write. Unprefixed references are resolved both as pages and modules concurrently and a warning is generated if the reference is ambiguous.
The printed warnings are not removed when loading a module by name.
The 'hierarchy_root' that ensures that relative references can't escape into other packages or libraries is different for modules and pages. This means that relative references can't be resolved from 'impl' units and from the 'html-url' command. The "current package dir" computation is changed to be more robust.
panglesd
approved these changes
Jul 22, 2024
| | Error `Escape_hierarchy -> None (* TODO: propagate more information *) | ||
| in | ||
| match tag with | ||
| | `TCurrentPackage -> | ||
| (* [path] is within the current package root. *) | ||
| page_path_to_path path >>= find_page |> option_to_page_result | ||
| ref_path_to_file_path path | ||
| |> List.find_map find_in_named_roots |
There was a problem hiding this comment.
Odoc_utils.List needs this function!
src/odoc/resolver.ml
Outdated
| match load_unit_from_file file with Some u -> u :: acc | None -> acc | ||
| in | ||
| List.fold_right safe_read paths [] | ||
| (** Returns [None] if the file is not found or failed to load for any reason. *) |
There was a problem hiding this comment.
I think this docstring has to be updated. This function returns a result.
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.
The code for resolving path-references is factorized into the
lookup_pathfunction. TheNamed_rootsfor libraries is used to locate modules.Env's API is changed to make theRef_toolspart easier to write.Unprefixed references are resolved both as pages and modules concurrently and a warning is generated if the reference is ambiguous.