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 not showing up through rust-analyzer when include_str! is used #929

Closed
udoprog opened this issue Apr 10, 2022 · 3 comments
Closed

Comments

@udoprog
Copy link

udoprog commented Apr 10, 2022

The way documentation is defined for certain functions prevents it from showing up through rust-analyzer (see screenshot).

This is what you see when you use into_make_service():
image

This is what you see when you use into_make_service_with_connect_info():
image

I don't know if this should count as a rust-analyzer issue, but it could be worth considering to improve usability of APIs with the current state of tooling.

@davidpdrsn
Copy link
Member

davidpdrsn commented Apr 10, 2022

Hm thats kinda annoying 😕 Its definitely a rust-analyzer bug. Using #[doc = include_str!(...)] was highlighted as a use case in the announcement of Rust 1.54 so I'd be sad having to remove it. On the other hand I understand the frustration. Docs are read more times than they're written.

Would you mind filing an issue with rust-analyzer?

@udoprog
Copy link
Author

udoprog commented Apr 10, 2022

Just looked, here are the related issues:

@davidpdrsn
Copy link
Member

I'll close this for now. I think its up to RA to fix this and at least seems they're aware of the issue.

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

No branches or pull requests

2 participants