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

Attach documentation comments to function type definitions #810

Open
dev-alastair opened this issue Nov 1, 2024 · 0 comments
Open

Attach documentation comments to function type definitions #810

dev-alastair opened this issue Nov 1, 2024 · 0 comments
Labels
blocked/external Blocked on external factor enhancement New feature or request

Comments

@dev-alastair
Copy link

dev-alastair commented Nov 1, 2024

When type annotations are added to functions at the point of their definition, moonwave-style function documentation works as expected and appears in Signature Help. However, when a type is defined separately, the documentation does not appear.

This works:
image

This does not work:
image
(Note: I've tried removing the comment on the type or the function definition so there is only one documentation comment, and it still doesn't work).

It would be awesome for this to be fixed, but also for the LSP to accept documentation comments in both places (either on types or function definitions) to allow types and documentation to be defined in one place, and implementations to be defined in another. Thanks so much for your work!

@JohnnyMorganz JohnnyMorganz changed the title Type definitions break Moonwave-style function documentation Attach documentation comments to function type definitions Nov 9, 2024
@JohnnyMorganz JohnnyMorganz added enhancement New feature or request blocked/external Blocked on external factor labels Nov 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked/external Blocked on external factor enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants