-
Notifications
You must be signed in to change notification settings - Fork 89
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix href for aliased modules in search results #1108
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
a0dbebf
Add a test for search links in module aliases
panglesd b817d4f
Search urls links to the definition point and not the expansion
panglesd 63819e6
Add changelog for #1108
panglesd f5c61fa
Change lower bound for search tests
panglesd 6dc65a9
Add clarifying comment for search links
panglesd File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
module X = struct | ||
let x = 1 | ||
|
||
(** some comment *) | ||
end | ||
|
||
module Y = X | ||
module Z = Y | ||
|
||
module L = Stdlib.List | ||
|
||
module type X = sig | ||
val x : int | ||
end | ||
|
||
module type Y = X | ||
module type Z = Y | ||
|
||
module type L = module type of Stdlib.List |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
Compile the files | ||
|
||
$ ocamlc -c main.ml -bin-annot -I . | ||
|
||
Compile and link the documentation | ||
|
||
$ odoc compile main.cmt | ||
$ odoc link main.odoc | ||
$ odoc compile-index main.odocl | ||
|
||
Search results only redirect to their definition point (not the | ||
expansions). Comments link to the expansion they are in. | ||
|
||
$ cat index.json | jq -r '.[] | "\(.id[-1].name) -> \(.display.url)"' | ||
Main -> Main/index.html | ||
X -> Main/index.html#module-X | ||
x -> Main/X/index.html#val-x | ||
X -> Main/X/index.html | ||
Y -> Main/index.html#module-Y | ||
Z -> Main/index.html#module-Z | ||
L -> Main/index.html#module-L | ||
X -> Main/index.html#module-type-X | ||
x -> Main/module-type-X/index.html#val-x | ||
Y -> Main/index.html#module-type-Y | ||
Z -> Main/index.html#module-type-Z | ||
L -> Main/index.html#module-type-L |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you please put a comment in the code here explaining why you're matching
Doc
? It's not very obvious!