Skip to content

Conversation

mladedav
Copy link
Collaborator

@mladedav mladedav commented Sep 14, 2025

Closes #929

Motivation

Documentation created with include_str does not show in rust-analyzer tooltips. The issue is tracked by rust-analyzer but there's no indication anyone would be able to work on it anytime soon.

Solution

Move the documentation inline. handlers_intro.md and debugging_handler_type_errors.md were used in two places so there is some duplication but not too much, one is 7 and the other 40 lines including empty lines.

Interestingly, even clippy and rustdoc seems to not support include_str fully as they do not warn on included docs the same way as they do on inline docs.

@jplatte
Copy link
Member

jplatte commented Sep 14, 2025

Thanks for taking care of this. I'll try to review in the next couple days.

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.

Documentation not showing up through rust-analyzer when include_str! is used

2 participants