Bug fixes #853
Merged
Bug fixes #853
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
For signatures like:
sig
module M := N
type t = M.t
end
we now render this as written rather than as
sig
module M := N
type t = N.t
end
I think this makes more sense (otherwise why render the
`module M := N` at all?)
This is analogous logic that was already present in the handling of cmi files.
The test was previously incorrect. An additional fix was also needed in the code for handling canonical modules, which was relying on the previous wrong behaviour.
Introduces a currently failing case where a shadowed identifier is created with a non-unique name.
Ensures that when including a signature that contains shadowed elements, these are refreshed to make sure the identifiers continue to be unique
Prior to this commit, the contents of included structs or sigs were inlined into the parent signature. This led to problems when there was shadowing happening. After this commit we need to be careful not to do twice as much work as necessary, since there are now _two_ `Signature.t` records in an include like this.
This should never happen, but it does. Further bug fixing required.
We don't use canonical on references, we assume the user will write the correct path. This commit removes the unused constructor.
Julow
reviewed
Jun 13, 2022
| in | ||
| match status with | ||
| | `Inline -> included_html | ||
| | `Closed -> details ~open':false | ||
| | `Open -> details ~open':true | ||
| | `Default -> details ~open':!Tree.open_details | ||
| in | ||
| let inc = [ Html.div ~a:[ Html.a_class a_class ] (doc @ content) ] in | ||
| (continue_with [@tailcall]) rest inc | ||
| (continue_with [@tailcall]) rest content |
There was a problem hiding this comment.
We loose the comment attached to the include. (the code doc @ _ is not in every branches, relevant test is test/generators/html/Toplevel_comments-Include_inline'.html)
There was a problem hiding this comment.
Ah! Good point thanks!
| $ ocamlc -c -bin-annot -I . c.mli | ||
| $ ocamlc -c -bin-annot -I . d.mli | ||
| $ odoc compile -I . c.cmti | ||
| $ odoc compile -I . d.cmti |
There was a problem hiding this comment.
Should also look at the result with odoc_print.
There was a problem hiding this comment.
Could do! I didn't put much thought into this - it was an example provided by Luke M that was failing in a nasty way, so I was satisfied that it didn't die horribly after this PR.
There was a problem hiding this comment.
On reflection I don't think I'll do this at this point, that it doesn't crash horribly is sufficient for now.
|
In it goes :-) |
mseri
pushed a commit
to ocaml/opam-repository
that referenced
this pull request
Dec 13, 2022
CHANGES: Additions - New unstable option `--as-json` for the HTML renderer that emits HTML fragments (preamble, content) together with metadata (table of contents, breadcrumbs, whether katex is used) in JSON format. (@sabine, ocaml/odoc#908) - New maths support via `{m ... }` and `{math ... }` tags. (@giltho, @gpetiot, ocaml/odoc#886) - Various optimisations (@jonludlam, ocaml/odoc#870, ocaml/odoc#883) - Better handling of alerts and deprecation notices. (@panglesd, ocaml/odoc#828) - Handle language tags on code blocks (@Julow, ocaml/odoc#848) Bugfixes - Shadowing issues (@jonludlam, ocaml/odoc#853) - Layout fixes and improvements (@panglesd, ocaml/odoc#832, ocaml/odoc#839, ocaml/odoc#847) - Handle comments on class constraints and inherit (@Julow, ocaml/odoc#844) - Disable the missing root warning (@jonludlam, ocaml/odoc#881)
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.
A set of fairly self-contained bug fixes found over the past few weeks.