Skip to content
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

Handle comments attached to class constraint and inherit #844

Merged
merged 4 commits into from
Jun 29, 2022

Conversation

Julow
Copy link
Collaborator

@Julow Julow commented Mar 4, 2022

Fix #574

The changes in the cmti loader is straightforward however it's not fully implemented for other inputs:

  • for cmts, the constraints are not read from the typedtree and I haven't made the effort to associate the comments correctly. Comments attached to constraints will appear as standalone comments anywhere in the class.
  • for cmis, it seems that these comments are lost ?

Most of the diffs is because of boilerplate due to changing some types in the model.

Copy link
Member

@jonludlam jonludlam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This all looks good, and surprisingly doesn't require any rebasing!

Julow and others added 4 commits June 29, 2022 23:24
Comment were not added into the model.
Constraints are handled separately and are not associated with their
comment. As a quick workaround, turn these into standalone comments.
Floating comments in classes are 4.08 and beyond
@jonludlam
Copy link
Member

Actually in order to get the tests run it did require rebasing :-) I've split the classes test in two as well as it was failing on OCaml < 4.08

@jonludlam jonludlam merged commit d4a8c50 into ocaml:master Jun 29, 2022
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Comments describing class inheritance are not rendered
2 participants