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

Show "doc comment" on hover over an identifier #898

Open
RalfJung opened this issue Sep 10, 2024 · 0 comments
Open

Show "doc comment" on hover over an identifier #898

RalfJung opened this issue Sep 10, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@RalfJung
Copy link

In other languages (at least in Rust), it is possible to associate a "doc comment" with a function, and when hovering a place in the code where that function is called, the doc comment will be shown. That is extremely useful to be able to quickly navigate foreign code.

It would be really nice if vscoq did something similar. I notice that hovering will show basically what About shows, which is already really nice. And probably doing any more is blocked on Coq having such a notion of a "doc comment" in the first place. But I think that would be valuable to have (also e.g. for search), so vscoq could be a motivation for Coq to adopt a system like that. :)

@rtetley rtetley added the enhancement New feature or request label Sep 13, 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