Fix references to extension declarations #949

gpetiot · 2023-03-31T16:32:15Z

Not working yet, I've written most of the boring code, some tweaking is needed to make it work.

the ExtensionDecl reference is added in Env
I think the lookup code in Ref_tools is correct
what is found in the Env is a Extension anchor, despite adding an ExtensionDecl

I think it's due to using Extension.t in the extension_decl type in Component:

type extension_decl =
  [ `ExtensionDecl of Identifier.Extension.t * Extension.Constructor.t ]

but changing everything creates too many changes. On the opposite side, it's probably possible to refactor the types, as maybe the existing Extension type might be enough in a lot of places, but I'm not familiar enough with the code to tell.

Ideas are welcome!

panglesd

I wonder how references should render: should we make a distinction between extension-A and extension-decl-A?

src/model/paths_types.ml

src/xref2/env.ml

src/xref2/find.ml

gpetiot · 2023-08-29T17:24:51Z

@panglesd the last commit (7bf16bd) does not compile, I tried to return a "nice" identifier in Ref_tools.ED.in_env that would contain the info of what is used for the url / what is displayed. It's hard to see if I went too far with the type changes (should Paths_types.Reference.any be modified?).
Le me know what you think. Feel free to take over and squash, rewrite, etc.

src/xref2/ref_tools.ml

gpetiot · 2023-09-29T08:52:05Z

@Julow @jonludlam this one is ready to be reviewed :) (I don't have the rights to add reviewers myself)

EmileTrotignon · 2023-10-03T14:01:36Z

src/xref2/component.mli

+      Identifier.Extension.t * Extension.Constructor.t * Extension.t ]
+
+  type extension_decl =
+    [ `ExtensionDecl of Identifier.Extension.t * Extension.Constructor.t ]


I know its not the case in the rest of the codebase, but I think these require comments to explain what each field corresponds to. There is such a comment in paths.mli, which is very nice.
For me, the comments in paths.mli helps me guess what the fields are for, but future people trying to find their way around odoc might read this file first.

EmileTrotignon · 2023-10-03T14:14:12Z

I have left a comment on a spot I think more comments are warranted, apart from that I think the PR is good.

Julow

I think the cleanup and comment commits could be squashed.

Otherwise, looks good to merge :)

gpetiot · 2023-10-10T23:15:21Z

I cleaned up and squashed the commits.

src/model/paths_types.ml

panglesd · 2023-10-26T15:28:46Z

Made a last minor modification, added changelog and documentation. Approved by @Julow and disapproved by no-one, merging as soon as CI is green.

Co-authored-by: Paul-Elliot <[email protected]>

Signed-off-by: Paul-Elliot <[email protected]>

@panglesd

CHANGES: ### Added - Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972) This includes the generation of an index and the display of the results in the UI (HTML only). - Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019) - Allow to omit parent type in constructor reference (@panglesd, @EmileTrotignon, ocaml/odoc#933) ### Fixed - Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046) - Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971) - Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949) ### Changed - Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045) - Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028) - Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967) - Style: Sidebar is now stuck to the left of the content instead of the left of the viewport (@EmileTrotignon, ocaml/odoc#999)

@panglesd

CHANGES: ### Added - Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972) This includes the generation of an index and the display of the results in the UI (HTML only). - Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019) - Allow to omit parent type in constructor reference (@panglesd, @EmileTrotignon, ocaml/odoc#933) ### Fixed - Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046) - Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971) - Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949) ### Changed - Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045) - Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028) - Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967) - Style: Sidebar is now stuck to the left of the content instead of the left of the viewport (@EmileTrotignon, ocaml/odoc#999)

@panglesd

CHANGES: ### Added - Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972) This includes the generation of an index and the display of the results in the UI (HTML only). - Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019) - Allow to omit parent type in constructor reference (@panglesd, @EmileTrotignon, ocaml/odoc#933) ### Fixed - Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046) - Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971) - Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949) ### Changed - Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045) - Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028) - Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967) - Style: Sidebar is now stuck to the left of the content instead of the left of the viewport (@EmileTrotignon, ocaml/odoc#999)

@panglesd

CHANGES: ### Added - Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972) This includes the generation of an index and the display of the results in the UI (HTML only). - Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019) - Allow to omit parent type in constructor reference (@panglesd, @EmileTrotignon, ocaml/odoc#933) ### Fixed - Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046) - Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971) - Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949) ### Changed - Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045) - Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028) - Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967) - Style: Sidebar is now stuck to the left of the content instead of the left of the viewport (@EmileTrotignon, ocaml/odoc#999)

@panglesd

CHANGES: ### Added - Add support for external search engines (@panglesd, @EmileTrotignon, ocaml/odoc#972) This includes the generation of an index and the display of the results in the UI (HTML only). - Display 'private' keyword for private type extensions (@gpetiot, ocaml/odoc#1019) - Allow to omit parent type in constructor reference (@panglesd, @EmileTrotignon, ocaml/odoc#933) ### Fixed - Warn and exit when table(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Hint when list(s) is not closed (@lubegasimon, ocaml/odoc#1050) - Fix crash on functors returning an alias (@Julow, ocaml/odoc#1046) - Fix rendering of polymorphic variants (@wikku, @panglesd, ocaml/odoc#971) - Add references to extension declarations (@gpetiot, @panglesd, ocaml/odoc#949) ### Changed - Style: Adjusted line height in the TOC to improve readability (@sorawee, ocaml/odoc#1045) - Style: Remove font fallback to Helvetica, Arial (@Julow, ocaml/odoc#1028) - Style: Preformatted elements fallback to UA monospace (@toastal, ocaml/odoc#967) - Style: Sidebar is now stuck to the left of the content instead of the left of the viewport (@EmileTrotignon, ocaml/odoc#999)

gpetiot marked this pull request as draft March 31, 2023 17:12

gpetiot changed the title ~~[WIP] Fix references to extension declarations~~ Fix references to extension declarations Mar 31, 2023

gpetiot marked this pull request as ready for review August 29, 2023 12:21

panglesd reviewed Aug 29, 2023

View reviewed changes

src/model/paths_types.ml Outdated Show resolved Hide resolved

src/model/paths_types.ml Outdated Show resolved Hide resolved

src/xref2/env.ml Outdated Show resolved Hide resolved

src/xref2/find.ml Outdated Show resolved Hide resolved

gpetiot requested a review from panglesd August 31, 2023 09:32

trefis assigned EmileTrotignon Sep 4, 2023

EmileTrotignon reviewed Sep 12, 2023

View reviewed changes

src/xref2/ref_tools.ml Show resolved Hide resolved

EmileTrotignon reviewed Oct 3, 2023

View reviewed changes

Julow approved these changes Oct 10, 2023

View reviewed changes

panglesd reviewed Oct 26, 2023

View reviewed changes

src/model/paths_types.ml Outdated Show resolved Hide resolved

Exhibit the bug of #932

dc56ea5

gpetiot and others added 5 commits October 26, 2023 17:30

Handle extension-decl anchors

c750aee

Co-authored-by: Paul-Elliot <[email protected]>

Bigger example

70f1645

Co-authored-by: Paul-Elliot <[email protected]>

Remove ambiguity warning

feaf7b9

Add changelog for #949

5aec08a

Signed-off-by: Paul-Elliot <[email protected]>

Documentation for reference to extension declaration

d971a4c

Signed-off-by: Paul-Elliot <[email protected]>

panglesd merged commit 2fcaef1 into ocaml:master Oct 26, 2023
4 of 5 checks passed

panglesd added a commit that referenced this pull request Oct 26, 2023

Add changelog for #949

e7a1876

Signed-off-by: Paul-Elliot <[email protected]>

gpetiot deleted the fix-932 branch October 26, 2023 23:57

Julow mentioned this pull request Dec 11, 2023

[new release] odoc and odoc-parser (2.4.0) ocaml/opam-repository#24927

Closed

Julow mentioned this pull request Dec 12, 2023

[new release] odoc and odoc-parser (2.4.0) ocaml/opam-repository#24930

Merged

gpetiot mentioned this pull request Jan 12, 2024

Compatibility with odoc.2.4.1 ocaml-doc/voodoo#128

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix references to extension declarations #949

Fix references to extension declarations #949

gpetiot commented Mar 31, 2023 •

edited

Loading

panglesd left a comment

gpetiot commented Aug 29, 2023

gpetiot commented Sep 29, 2023

EmileTrotignon Oct 3, 2023 •

edited

Loading

EmileTrotignon commented Oct 3, 2023

Julow left a comment

gpetiot commented Oct 10, 2023

panglesd commented Oct 26, 2023 •

edited

Loading

Fix references to extension declarations #949

Fix references to extension declarations #949

Conversation

gpetiot commented Mar 31, 2023 • edited Loading

panglesd left a comment

Choose a reason for hiding this comment

gpetiot commented Aug 29, 2023

gpetiot commented Sep 29, 2023

EmileTrotignon Oct 3, 2023 • edited Loading

Choose a reason for hiding this comment

EmileTrotignon commented Oct 3, 2023

Julow left a comment

Choose a reason for hiding this comment

gpetiot commented Oct 10, 2023

panglesd commented Oct 26, 2023 • edited Loading

gpetiot commented Mar 31, 2023 •

edited

Loading

EmileTrotignon Oct 3, 2023 •

edited

Loading

panglesd commented Oct 26, 2023 •

edited

Loading