chore: move docs from markdown files to rust source #3479
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #929
Motivation
Documentation created with
include_str
does not show inrust-analyzer
tooltips. The issue is tracked byrust-analyzer
but there's no indication anyone would be able to work on it anytime soon.Solution
Move the documentation inline.
handlers_intro.md
anddebugging_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.