Regression test for worse documentation result produced in bin-annot-cms mode#35
Merged
ncik-roberts merged 1 commit intomainfrom Jan 4, 2024
Conversation
goldfirere
approved these changes
Jan 3, 2024
Contributor
Author
|
This test will change output when we import oxcaml/oxcaml#2206 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Cf.
tests/test-dirs/document/module-doc.t, which has the good output.Problem: requesting the documentation for a module from merlin produces a bad result ("No documentation available") even when the module has a top-level doc comment.
Two ingredients appear to be necessary:
[@@@ocaml.doc "doc comment here"]instead of(** doc comment here *). (Or the user ran a ppx preprocessor.)-bin-annot-cmsto the compiler instead of-bin-annot.Tracked in internal ticket 2135.