Skip to content

Make the prefix argument to merlin-locate optional#1476

Merged
voodoos merged 1 commit intoocaml:masterfrom
antalsz:merlin-locate-optional-argument
Jun 28, 2022
Merged

Make the prefix argument to merlin-locate optional#1476
voodoos merged 1 commit intoocaml:masterfrom
antalsz:merlin-locate-optional-argument

Conversation

@antalsz
Copy link
Copy Markdown
Contributor

@antalsz antalsz commented Jun 6, 2022

The merlin-locate command had a prefix argument added; it's elisp convention for prefix arguments to be optional, and this is especially helpful as the merlin-locate command is user-facing and this provides for backwards compatibility.

This change can also be backported to the 412 and 411 branches.

@voodoos
Copy link
Copy Markdown
Collaborator

voodoos commented Jun 15, 2022

Looks good to me, thank you @antalsz, could you add a changelog entry ?

Also do you have a specific need for this to be backported to 411 ? We dropped official support for this branch this the release of 4.14.

@bbatsov
Copy link
Copy Markdown

bbatsov commented Jun 21, 2022

@antalsz This might also be a good time to document what the 2 prefix arguments actually do. :-) Also - it's Emacs convention to use more descriptive names than prefix and to document all arguments in the docstrings.

@antalsz
Copy link
Copy Markdown
Contributor Author

antalsz commented Jun 23, 2022

@voodoos: Changelog entry added, and no need for 411 – I just didn't realize you'd dropped support, so I was looking back anywhere it seemed relevant.

@bbatsov: Thanks for the reminder to make a comprehensive PR rather than a minimal PR, it's appreciated :-)

@voodoos voodoos added this to the 4.6 / 3.8 milestone Jun 24, 2022
@bbatsov
Copy link
Copy Markdown

bbatsov commented Jun 24, 2022

The PR looks good to me now. I'd only suggest squashing all commits together, although I guess @voodoos can also do this at merge time.

Improve the docstring for `merlin-locate` and add a changelog entry

Delete stray `(provide 'merlin)` line
@voodoos voodoos force-pushed the merlin-locate-optional-argument branch from df922d8 to c975a26 Compare June 28, 2022 16:07
@voodoos voodoos merged commit 850d4a7 into ocaml:master Jun 28, 2022
antalsz added a commit to oxcaml/merlin that referenced this pull request Jun 29, 2022
Improve the docstring for `merlin-locate` and add a changelog entry

(Supersedes the prior commit to this effect by pulling in the
improvements for the upstream PR)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Jun 30, 2022
CHANGES:

Thu Jun 30 14:51:42 CEST 2022

  + merlin binary
    - make most library public and split merlin in two packages: the
      `merlin-lib` package that exposes merlin's internals and the `merlin`
      package with the frontend. (ocaml/merlin#1448, ocaml/merlin#1455, ocaml/merlin#1457, ocaml/merlin#1497, @rgrinberg,
      @tmattio, @kit-ty-kate)
    - Type printing: use best_module_path for paths from Mty_alias (ocaml/merlin#1470)
    - Attempt at finding the 'real' capitalization of files on windows (ocaml/merlin#1462 by
      @mlasson)
    - Use newer `Seq`-based API of Yojson 2.0, avoiding the need for the
      deprecated `Stream` module (ocaml/merlin#1475 by @Leonidas-from-XIV)
    - unify parsing of `MERLIN_LOG` (ocaml/merlin#1480 by @ulugbekna)
    - Fix type deduplication in `type-enclosing` results (ocaml/merlin#1483, fixes ocaml/merlin#1477)
    - Only weakly reduce the shapes to speed up the new Merlin locate
      implementation. (ocaml/merlin#1488)
    - Ignore unknown configuration tags from dune configuration provider but not
      from dot-merlin-reader (ocaml/merlin#1486)
    - typing recovery: recover at the granularity of `core_type` (ocaml/merlin#1484)
  + editor modes
    - add method imenu items for emacs (ocaml/merlin#1481, @mndrix)
    - emacs: Make the prefix argument to `merlin-locate` optional, both for
      consistency with Emacs convention and for backwards compatibility. (ocaml/merlin#1476,
      @antalsz)
    - emacs: fix duplicated prefix path in imenu entries (ocaml/merlin#1495, @bcc32)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Jul 1, 2022
CHANGES:

Fri Jul  1 12:51:42 CEST 2022

  + merlin binary
    - Type printing: use `best_module_path` for paths from `Mty_alias` (ocaml/merlin#1470)
    - Attempt at finding the 'real' capitalization of files on windows (ocaml/merlin#1462 by
      @mlasson)
    - Use newer `Seq`-based API of Yojson 2.0, avoiding the need for the
      deprecated `Stream` module (ocaml/merlin#1475 by @Leonidas-from-XIV)
    - unify parsing of `MERLIN_LOG` (ocaml/merlin#1480 by @ulugbekna)
    - Fix type deduplication in `type-enclosing` results (ocaml/merlin#1483, fixes ocaml/merlin#1477)
    - Ignore unknown configuration tags from dune configuration provider but not
      from dot-merlin-reader (ocaml/merlin#1486)
    - typing recovery: recover at the granularity of `core_type` (ocaml/merlin#1484)
  + editor modes
    - Fix `merlin-locate-in-new-window` is ignored (ocaml/merlin#1461 by @emturner,
      fixes ocaml/merlin#1460)
    - add method imenu items for emacs (ocaml/merlin#1481, @mndrix)
    - emacs: Make the prefix argument to `merlin-locate` optional, both for
      consistency with Emacs convention and for backwards compatibility. (ocaml/merlin#1476,
      @antalsz)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Jul 1, 2022
CHANGES:

Fri Jul  1 12:51:42 CEST 2022

  + merlin binary
    - Type printing: use `best_module_path` for paths from `Mty_alias` (ocaml/merlin#1470)
    - Attempt at finding the 'real' capitalization of files on windows (ocaml/merlin#1462 by
      @mlasson)
    - Use newer `Seq`-based API of Yojson 2.0, avoiding the need for the
      deprecated `Stream` module (ocaml/merlin#1475 by @Leonidas-from-XIV)
    - unify parsing of `MERLIN_LOG` (ocaml/merlin#1480 by @ulugbekna)
    - Fix type deduplication in `type-enclosing` results (ocaml/merlin#1483, fixes ocaml/merlin#1477)
    - Ignore unknown configuration tags from dune configuration provider but not
      from dot-merlin-reader (ocaml/merlin#1486)
    - typing recovery: recover at the granularity of `core_type` (ocaml/merlin#1484)
  + editor modes
    - Fix `merlin-locate-in-new-window` is ignored (ocaml/merlin#1461 by @emturner,
      fixes ocaml/merlin#1460)
    - add method imenu items for emacs (ocaml/merlin#1481, @mndrix)
    - emacs: Make the prefix argument to `merlin-locate` optional, both for
      consistency with Emacs convention and for backwards compatibility. (ocaml/merlin#1476,
      @antalsz)
    - emacs: fix duplicated prefix path in imenu entries (ocaml/merlin#1495, @bcc32)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Jul 1, 2022
CHANGES:

Fri Jul  1 12:51:42 CEST 2022

  + merlin binary
    - Type printing: use `best_module_path` for paths from `Mty_alias` (ocaml/merlin#1470)
    - Attempt at finding the 'real' capitalization of files on windows (ocaml/merlin#1462 by
      @mlasson)
    - Use newer `Seq`-based API of Yojson 2.0, avoiding the need for the
      deprecated `Stream` module (ocaml/merlin#1475 by @Leonidas-from-XIV)
    - unify parsing of `MERLIN_LOG` (ocaml/merlin#1480 by @ulugbekna)
    - Fix type deduplication in `type-enclosing` results (ocaml/merlin#1483, fixes ocaml/merlin#1477)
    - Ignore unknown configuration tags from dune configuration provider but not
      from dot-merlin-reader (ocaml/merlin#1486)
    - typing recovery: recover at the granularity of `core_type` (ocaml/merlin#1484)
  + editor modes
    - Fix `merlin-locate-in-new-window` is ignored (ocaml/merlin#1461 by @emturner,
      fixes ocaml/merlin#1460)
    - add method imenu items for emacs (ocaml/merlin#1481, @mndrix)
    - emacs: Make the prefix argument to `merlin-locate` optional, both for
      consistency with Emacs convention and for backwards compatibility. (ocaml/merlin#1476,
      @antalsz)
    - emacs: fix duplicated prefix path in imenu entries (ocaml/merlin#1495, @bcc32)
voodoos added a commit to voodoos/opam-repository that referenced this pull request Jul 1, 2022
CHANGES:

Fri Jul  1 12:51:42 CEST 2022

  + merlin binary
    - Type printing: use `best_module_path` for paths from `Mty_alias` (ocaml/merlin#1470)
    - Attempt at finding the 'real' capitalization of files on windows (ocaml/merlin#1462 by
      @mlasson)
    - Use newer `Seq`-based API of Yojson 2.0, avoiding the need for the
      deprecated `Stream` module (ocaml/merlin#1475 by @Leonidas-from-XIV)
    - unify parsing of `MERLIN_LOG` (ocaml/merlin#1480 by @ulugbekna)
    - Fix type deduplication in `type-enclosing` results (ocaml/merlin#1483, fixes ocaml/merlin#1477)
    - Ignore unknown configuration tags from dune configuration provider but not
      from dot-merlin-reader (ocaml/merlin#1486)
    - typing recovery: recover at the granularity of `core_type` (ocaml/merlin#1484)
  + editor modes
    - Fix `merlin-locate-in-new-window` is ignored (ocaml/merlin#1461 by @emturner,
      fixes ocaml/merlin#1460)
    - add method imenu items for emacs (ocaml/merlin#1481, @mndrix)
    - emacs: Make the prefix argument to `merlin-locate` optional, both for
      consistency with Emacs convention and for backwards compatibility. (ocaml/merlin#1476,
      @antalsz)
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.

3 participants