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

Documentation-on-hover support for new OTP27 doc attributes #54

Open
NelsonVides opened this issue Sep 4, 2024 · 1 comment
Open

Documentation-on-hover support for new OTP27 doc attributes #54

NelsonVides opened this issue Sep 4, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@NelsonVides
Copy link

Describe the bug

When hovering over function calls, documentation-on-hover shows information only if the documentation was written in the older edoc format, but not in the newer OTP27 doc attributes.

image image

To Reproduce**

In the following code:

%% @doc this is edoc
edoc_dummy() ->
    ok.

-doc """
This is a doc attribute
""".
docattr_dummy() ->
    ok.

callers() ->
    ?MODULE:edoc_dummy(),
    ?MODULE:docattr_dummy(),
    ok.

Expected behavior

I'd expect both documentation types to display on hovering.

Actual behavior

edoc_dummy/1 hovering displays the edoc information, but docattr_dummy/1 does not.

Context

  • ELP Version (output of elp version): elp 1.1.0+build-2024-08-05
  • Editor used: neovim
@NelsonVides NelsonVides added the bug Something isn't working label Sep 4, 2024
@robertoaloi
Copy link
Contributor

@NelsonVides This is correct. Support for OTP 27 style EDoc is not added yet (but it's planned).

@robertoaloi robertoaloi added enhancement New feature or request and removed bug Something isn't working labels Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants