Skip to content

Do not drop comments attached to open#797

Merged
jonludlam merged 3 commits intoocaml:masterfrom
panglesd:fix-745
Dec 14, 2021
Merged

Do not drop comments attached to open#797
jonludlam merged 3 commits intoocaml:masterfrom
panglesd:fix-745

Conversation

@panglesd
Copy link
Copy Markdown
Collaborator

This PR fixes #745 by keeping comments attached to open.

They are handled the same way as floating comments.

Signed-off-by: Paul-Elliot <peada@free.fr>
Signed-off-by: Paul-Elliot <peada@free.fr>
@jonludlam
Copy link
Copy Markdown
Member

Very nice! Could you please add a test and a changes entry?

Copy link
Copy Markdown
Collaborator

@Julow Julow left a comment

Choose a reason for hiding this comment

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

Looks good to me :) It renders like a floating comment, which is what we want I think.

Can you add a test ? The best place would be test/generator/toplevel_comments.mli.

Signed-off-by: Paul-Elliot <peada@free.fr>
@panglesd
Copy link
Copy Markdown
Collaborator Author

Thanks @Julow and @jonludlam.

I added a test and a change entry!

@jonludlam jonludlam merged commit 8ae78e6 into ocaml:master Dec 14, 2021
jonludlam added a commit to jonludlam/opam-repository that referenced this pull request Feb 8, 2022
CHANGES:

Additions
- New subcommand to resolve references (@panglesd, @lubega-simon, ocaml/odoc#812)
- Improved rendering of long signatures (@panglesd, ocaml/odoc#782)
- Handle comments attached to open statement as floating comment, instead
  of dropping them (@panglesd, ocaml/odoc#797)
- Empty includes (containing entirely shadowed entries) are now hidden (@panglesd, ocaml/odoc#798)

Bugs fixed
- Fix a missing Result constructor during compile. This will cause some
  functor arguments to have different filenames (@jonludlam, ocaml/odoc#795)
- Better memory/disk space usage when handling module alias chains (@jonludlam, ocaml/odoc#799)
- Resolving class-type paths (ie., `val x : #c`) (@jonludlam, ocaml/odoc#809)
- Skip top-level attributes while extracting the top comment. Fix top-comment extraction with PPX preprocessing (@jorisgio, ocaml/odoc#819)
- Better handling of @canonical tags (@jonludlam, ocaml/odoc#820)
- css: improved layout (@jonludlam, @Julow, ocaml/odoc#822)
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.

Comment attached to an open is dropped

3 participants