rust-lang / rust-lang/rust-analyzer
Update format_like generated docs and gif
Open
Nobody has claimed this yet.
A-documentation
- Dominant language
- Rust
- Stars
- 16.9k
- Forks
- 2.2k
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 72
Description
--- a/crates/ide-completion/src/completions/postfix/format_like.rs 2025-09-20 20:37:42.740000000 +0800
+++ b/crates/ide-completion/src/completions/postfix/format_like.rs 2026-03-21 18:32:59.637801943 +0800
@@ -3 +3 @@
-// `"Result {result} is {2 + 2}"` is expanded to the `"Result {} is {}", result, 2 + 2`.
+// `"Result {result} is {2 + 2}"` is expanded to the `"Result {result} is {}", 2 + 2`.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with crates/ide-completion/src/completions/postfix/format_like.rs and inspect the shown comment change. Identify how the generated docs and GIF for format_like are produced, then update them so they reflect the revised expansion wording. Done means the source comment, generated documentation, and GIF are consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100