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.

Sign up for GitHub

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

Jump to bottom

Improv document request #1542

Merged
merged 3 commits into from Feb 24, 2023
Merged

Improv document request #1542

merged 3 commits into from Feb 24, 2023

Conversation

voodoos
Copy link
Collaborator

@voodoos voodoos commented Dec 6, 2022

Fix #1540 along with another issue where Merlin was unable to fetch documentation for the mli of the current compilation unit.

@voodoos voodoos added this to Planned for backporting in Backport to 500 via automation Feb 1, 2023
@voodoos voodoos added this to the Next release milestone Feb 1, 2023
@voodoos voodoos requested a review from trefis February 1, 2023 12:23
@voodoos voodoos force-pushed the fix-issue1540-doc-at-definition branch from abf6944 to 3cc47c4 Compare February 1, 2023 12:28
@voodoos voodoos mentioned this pull request Feb 23, 2023
Draft
@voodoos voodoos force-pushed the fix-issue1540-doc-at-definition branch from 3cc47c4 to fd62de1 Compare February 23, 2023 09:33
voodoos added a commit to voodoos/merlin that referenced this pull request Feb 23, 2023
@voodoos
Add changelog entry for ocaml#1542
a77f72c
@voodoos
Copy link
Collaborator Author

voodoos commented Feb 23, 2023

cc @trefis I removed the controversial commits.

@voodoos
Add a test illustrating issue 1540
f937c9b 
Merlin does not find the docstring of the current definition
@voodoos
Fix the issue by relying on the heuristic when at origin.
0c0cdec 
There might still be a problem when the comment is associated to the declaration.
@voodoos
Add changelog entry for ocaml#1542
e4bacab
@voodoos voodoos force-pushed the fix-issue1540-doc-at-definition branch from a77f72c to e4bacab Compare February 24, 2023 15:27
@voodoos voodoos merged commit 2411aaf into ocaml:master Feb 24, 2023
Backport to 500 automation moved this from Planned for backporting to Ready for backporting Feb 24, 2023
@voodoos voodoos moved this from Ready for backporting to 4.8-500 in Backport to 500 Feb 24, 2023
voodoos added a commit to voodoos/merlin that referenced this pull request Feb 24, 2023
@voodoos
Backport: Fix doc request at origin ocaml#1542
2d30dbb 
 from voodoos/fix-issue1540-doc-at-definition
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 24, 2023
@voodoos
[new release] merlin, merlin-lib and dot-merlin-reader (4.8-500)
7714029 
CHANGES:

Fri Feb 24 16:55:42 CEST 2023

  + merlin binary
    - Recognize OCaml 5.0 cmi magic number in compiler version mismatch message
      (ocaml/merlin#1554, fixes ocaml/merlin#1553)
    - Upgrade Merlin from the RC2 to the stable 5.0.0 compiler release (ocaml/merlin#1559,
      fixes ocaml/merlin#1558)
    - Improve type-enclosing behaviour when used on records' labels (ocaml/merlin#1565,
      fixes ocaml/merlin#1564)
    - Restore compatibility with the compiler's command line by accepting the
      `-safe-string` flag as a no-op instead of rejecting it (ocaml/merlin#1544, fixes
      ocaml/merlin#1518)
    - Traverse aliases when jumping to declaration. This matches
      jump-to-definition's behavior (ocaml/merlin#1563)
    - Improve locate's behavior in various ill-typed expressions (ocaml/merlin#1546, fixes
      ocaml/merlin#1567 and partially ocaml/merlin#1543)
    - Correctly traverse patterns when looking for docs in the typedtree (ocaml/merlin#1572)
    - Get documentation when the declaration or definition is selected (ocaml/merlin#1542,
      fixes ocaml/merlin#1540)
    - On Windows, change to a harmless directory when launching server to avoid
      locking down current directory (ocaml/merlin#1569, fixes ocaml/merlin#1474)
  + editor modes
    - emacs: Fix misuse of `eq` comparison (ocaml/merlin#1549, @mattiase)
    - emacs: xref works from context menus; better highlighting of xref matches;
      xref recognises operators and binding operators at the cursor position;
      bad locations are filtered out (ocaml/merlin#1385, fixes ocaml/merlin#1410, @mattiase)
  + test suite
    - Add a test for incorrect alert defaults (ocaml/merlin#1559)
    - Add multiple tests for locate over ill-typed expressions (ocaml/merlin#1546)
    - Add non-regression tests for other fixes in this release
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 24, 2023
@voodoos
[new release] merlin, merlin-lib and dot-merlin-reader (4.8-414)
66e2ca2 
CHANGES:

Fri Feb 24 16:55:42 CEST 2023

  + merlin binary
    - Update internal typer to match OCaml 4.14.1 release (ocaml/merlin#1557)
    - Improve type-enclosing behaviour when used on records' labels (ocaml/merlin#1565,
      fixes ocaml/merlin#1564)
    - Restore compatibility with some OCaml compiler's debug flags that were
      incorrectly rejected by Merlin (ocaml/merlin#1556)
    - Traverse aliases when jumping to declaration. This matches
      jump-to-definition's behavior (ocaml/merlin#1563)
    - Improve locate's behavior in various ill-typed expressions (ocaml/merlin#1546, fixes
      ocaml/merlin#1567 and partially ocaml/merlin#1543)
    - Correctly traverse patterns when looking for docs in the typedtree (ocaml/merlin#1572)
    - Get documentation when the declaration or definition is selected (ocaml/merlin#1542,
      fixes ocaml/merlin#1540)
    - On Windows, change to a harmless directory when launching server to avoid
      locking down current directory (ocaml/merlin#1569, fixes ocaml/merlin#1474)
  + test suite
    - Add multiple tests for locate over ill-typed expressions (ocaml/merlin#1546)
    - Add non-regression tests for other fixes in this release
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 24, 2023
@voodoos
[new release] merlin and merlin-lib (4.8-500)
86ebee5 
CHANGES:

Fri Feb 24 16:55:42 CEST 2023

  + merlin binary
    - Recognize OCaml 5.0 cmi magic number in compiler version mismatch message
      (ocaml/merlin#1554, fixes ocaml/merlin#1553)
    - Upgrade Merlin from the RC2 to the stable 5.0.0 compiler release (ocaml/merlin#1559,
      fixes ocaml/merlin#1558)
    - Improve type-enclosing behaviour when used on records' labels (ocaml/merlin#1565,
      fixes ocaml/merlin#1564)
    - Restore compatibility with the compiler's command line by accepting the
      `-safe-string` flag as a no-op instead of rejecting it (ocaml/merlin#1544, fixes
      ocaml/merlin#1518)
    - Traverse aliases when jumping to declaration. This matches
      jump-to-definition's behavior (ocaml/merlin#1563)
    - Improve locate's behavior in various ill-typed expressions (ocaml/merlin#1546, fixes
      ocaml/merlin#1567 and partially ocaml/merlin#1543)
    - Correctly traverse patterns when looking for docs in the typedtree (ocaml/merlin#1572)
    - Get documentation when the declaration or definition is selected (ocaml/merlin#1542,
      fixes ocaml/merlin#1540)
    - On Windows, change to a harmless directory when launching server to avoid
      locking down current directory (ocaml/merlin#1569, fixes ocaml/merlin#1474)
  + editor modes
    - emacs: Fix misuse of `eq` comparison (ocaml/merlin#1549, @mattiase)
    - emacs: xref works from context menus; better highlighting of xref matches;
      xref recognises operators and binding operators at the cursor position;
      bad locations are filtered out (ocaml/merlin#1385, fixes ocaml/merlin#1410, @mattiase)
  + test suite
    - Add a test for incorrect alert defaults (ocaml/merlin#1559)
    - Add multiple tests for locate over ill-typed expressions (ocaml/merlin#1546)
    - Add non-regression tests for other fixes in this release
voodoos added a commit to voodoos/opam-repository that referenced this pull request Feb 24, 2023
@voodoos
[new release] merlin and merlin-lib (4.8-414)
4a8bdc7 
CHANGES:

Fri Feb 24 16:55:42 CEST 2023

  + merlin binary
    - Update internal typer to match OCaml 4.14.1 release (ocaml/merlin#1557)
    - Improve type-enclosing behaviour when used on records' labels (ocaml/merlin#1565,
      fixes ocaml/merlin#1564)
    - Restore compatibility with some OCaml compiler's debug flags that were
      incorrectly rejected by Merlin (ocaml/merlin#1556)
    - Traverse aliases when jumping to declaration. This matches
      jump-to-definition's behavior (ocaml/merlin#1563)
    - Improve locate's behavior in various ill-typed expressions (ocaml/merlin#1546, fixes
      ocaml/merlin#1567 and partially ocaml/merlin#1543)
    - Correctly traverse patterns when looking for docs in the typedtree (ocaml/merlin#1572)
    - Get documentation when the declaration or definition is selected (ocaml/merlin#1542,
      fixes ocaml/merlin#1540)
    - On Windows, change to a harmless directory when launching server to avoid
      locking down current directory (ocaml/merlin#1569, fixes ocaml/merlin#1474)
  + test suite
    - Add multiple tests for locate over ill-typed expressions (ocaml/merlin#1546)
    - Add non-regression tests for other fixes in this release
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trefis trefis Awaiting requested review from trefis

Assignees
No one assigned
Labels
None yet
Projects
Backport to 500
4.8-500
Milestone
Next release
Development

Successfully merging this pull request may close these issues.

doc for identifier in let definition is not found - regression
1 participant
@voodoos