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

Fix #1823: support newer eldoc protocol #1825

Merged
merged 2 commits into from
Aug 5, 2020

Conversation

joaotavora
Copy link
Contributor

This UNTESTED commit should hint at how to fix the issue without
resorting to `eldoc-docstring-format-sym-doc', which is gone in Emacs
28 (ElDoc 1.1.0).

Beyond the ideas delineated in this commit, the new ElDoc protocol
would also easily obviate the need to have "flymake-specific" ElDoc
code in ElPy (this is now default in stock Flymake), as well as being
forced to choose between different types of ElPy docstrings.

  • elpy.el (elpy-module-eldoc): Add to eldoc-documentation-functions.
    (elpy-eldoc-documentation): Rework to support
    eldoc-documentation-functions.

PR Summary

PR checklist

Please make sure that the following things have been addressed (and check the relevant checkboxes):

  • Commits respect our guidelines
  • Tests are passing properly (see here on how to run Elpy's tests)

For new features only:

  • Tests has been added to cover the change
  • The documentation has been updated

joaotavora and others added 2 commits July 27, 2020 15:16
This UNTESTED commit should hint at how to fix the issue without
resorting to `eldoc-docstring-format-sym-doc', which is gone in Emacs
28 (ElDoc 1.1.0).

Beyond the ideas delineated in this commit, the new ElDoc protocol
would also easily obviate the need to have "flymake-specific" ElDoc
code in ElPy (this is now default in stock Flymake), as well as being
forced to choose between different types of ElPy docstrings.

* elpy.el (elpy-module-eldoc): Add to eldoc-documentation-functions.
(elpy-eldoc-documentation): Rework to support
eldoc-documentation-functions.
@coveralls
Copy link

Coverage Status

Coverage decreased (-3.2%) to 88.973% when pulling 17a9d09 on joaotavora:master into 03a7517 on jorgenschaefer:master.

@galaunay
Copy link
Collaborator

galaunay commented Aug 5, 2020

Thanks for that.
And good to know Eldoc is becoming better.

I took the liberty to make minor changes and fix the failing test.

@galaunay galaunay merged commit 718896c into jorgenschaefer:master Aug 5, 2020
@joaotavora
Copy link
Contributor Author

joaotavora commented Aug 5, 2020

I took the liberty to make minor changes and fix the failing test.

Cool. Did you actually test it on Emacs 28? Becasue I didn't. I'm sorry if I didn't make it clearer earlier (EDIT: actually, I did make it all caps clear... :-) )

@galaunay
Copy link
Collaborator

galaunay commented Aug 5, 2020

You did make it clear :) .
I tested it (not thoroughly though) on the master branch.

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.

None yet

3 participants