[vim/vim] Fix ft_rust.txt (tw78, grammar, spaces, etc) (PR #19887)

Peter Kenny

unread,

Apr 1, 2026, 9:23:59 PM (2 days ago) Apr 1

to vim/vim, Subscribed

Fixes

All lines >78 display characters are addressed - there were several.
Sentences now have two spaces to start (so, sentence navigation will work now).
Line 24: The :b should be b: (and is what brought me to look at this help file in the first place....)
Loads of multiple spaces are replaced with tabs. Also, blank lines in places where there was too much white space between content. This reduces the file size by a significant, surprising amount (~15%), so is worth it from the efficiency perspective too. [NB: Changes are in line with previous discussions on white space in help files, indenting of code efficiently, etc.]
“...which can overrides...” is fixed.
A couple of missing . in sentences ending, “...for performance
reasons”.
Some instances of single quoted things are changed to double quoted (because they appear syntax highlighted as Vim options, which is misleading/unhelpful).
Line 362 (previously 384), fixes grammatical errors in the note. It now reads (which I think is what it’s trying to say):
NOTE: These commands are useful only when working with standalone Rust files, which is usually not the case for common Rust development. If you wish to build Rust crates from within Vim, use Vim's make, Syntastic, or functionality from other plugins.
Line 474 (previously 496), now specifies the modes the mappings are defined in.
Minor grammatical and spelling errors are corrected, including:
- “from with Vim” now “from within Vim” in two places.
- “shorterner” corrected to “shortener”.
- Missing articles such as “a shell command” and “a large workspace”.

Other considerations

Several documented variables appear to have no effect. They have not been touched in this PR, though, if wanted, I can add a comment later with what could be considered.

You can view, comment on, or merge this pull request online at:

https://github.com/vim/vim/pull/19887

Commit Summary

673d773 Fix ft_rust.txt (tw78, grammar, spaces, etc)

File Changes

(1 file)

M runtime/doc/ft_rust.txt (405)

Patch Links:

—
Reply to this email directly, view it on GitHub.
You are receiving this because you are subscribed to this thread.

Christian Brabandt

unread,

Apr 2, 2026, 12:52:17 PM (13 hours ago) Apr 2

to vim/vim, Subscribed

@chrisbra commented on this pull request.

In runtime/doc/ft_rust.txt:

>  --------------------------
 
-This plugin automatically integrates with the Syntastic checker. There are two
-checkers provided: 'rustc', and 'cargo'. The latter invokes 'Cargo' in order to
-build code, and the former delivers a single edited '.rs' file as a compilation
-target directly to the Rust compiler, `rustc`.
+This plugin automatically integrates with the Syntastic checker.  There are
+two checkers provided: "rustc", and "cargo".  The latter invokes 'Cargo' in

Although this is not detected as option, I think we should still use double quotes here:

⬇️ Suggested change

-two checkers provided: "rustc", and "cargo".  The latter invokes 'Cargo' in
+two checkers provided: "rustc", and "cargo".  The latter invokes "Cargo" in

Also I am wondering: should cargo be lower case?

In runtime/doc/ft_rust.txt:

>  --------------------------
 
-This plugin automatically integrates with the Syntastic checker. There are two
-checkers provided: 'rustc', and 'cargo'. The latter invokes 'Cargo' in order to
-build code, and the former delivers a single edited '.rs' file as a compilation
-target directly to the Rust compiler, `rustc`.
+This plugin automatically integrates with the Syntastic checker.  There are
+two checkers provided: "rustc", and "cargo".  The latter invokes 'Cargo' in
+order to build code, and the former delivers a single edited '.rs' file as a

⬇️ Suggested change

-order to build code, and the former delivers a single edited '.rs' file as a
+order to build code, and the former delivers a single edited ".rs" file as a

In runtime/doc/ft_rust.txt:

>  g:rust_cargo_check_benches~
 	When set to 1, the `--benches` option will be passed to cargo when
 	Syntastic executes it.  The benches are normally under the `benches/`
 	directory of the crate.
 	The default is 0.
 
-Integration with auto-pairs                                    *rust-auto-pairs*
+

unnecessary white line?

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.

Peter Kenny

unread,

Apr 2, 2026, 2:53:03 PM (11 hours ago) Apr 2

to vim/vim, Push

@kennypete pushed 1 commit.

170ae3a Fix ft_rust.txt (tw78, grammar, spaces, etc)

—
View it on GitHub.
You are receiving this because you are subscribed to this thread.

Peter Kenny

unread,

Apr 2, 2026, 2:55:40 PM (11 hours ago) Apr 2

to vim/vim, Subscribed

@kennypete commented on this pull request.

In runtime/doc/ft_rust.txt:

>  --------------------------
 
-This plugin automatically integrates with the Syntastic checker. There are two
-checkers provided: 'rustc', and 'cargo'. The latter invokes 'Cargo' in order to
-build code, and the former delivers a single edited '.rs' file as a compilation
-target directly to the Rust compiler, `rustc`.
+This plugin automatically integrates with the Syntastic checker.  There are
+two checkers provided: "rustc", and "cargo".  The latter invokes 'Cargo' in

Yes, that's changed in updated commit just pushed now. Details in last comment, below.

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.

Peter Kenny

unread,

Apr 2, 2026, 2:56:11 PM (11 hours ago) Apr 2

to vim/vim, Subscribed

@kennypete commented on this pull request.

In runtime/doc/ft_rust.txt:

>  --------------------------
 
-This plugin automatically integrates with the Syntastic checker. There are two
-checkers provided: 'rustc', and 'cargo'. The latter invokes 'Cargo' in order to
-build code, and the former delivers a single edited '.rs' file as a compilation
-target directly to the Rust compiler, `rustc`.
+This plugin automatically integrates with the Syntastic checker.  There are
+two checkers provided: "rustc", and "cargo".  The latter invokes 'Cargo' in
+order to build code, and the former delivers a single edited '.rs' file as a

Ditto comment above.

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.

Peter Kenny

unread,

Apr 2, 2026, 3:09:08 PM (11 hours ago) Apr 2

to vim/vim, Subscribed

@kennypete commented on this pull request.

In runtime/doc/ft_rust.txt:

>  g:rust_cargo_check_benches~
 	When set to 1, the `--benches` option will be passed to cargo when
 	Syntastic executes it.  The benches are normally under the `benches/`
 	directory of the crate.
 	The default is 0.
 
-Integration with auto-pairs                                    *rust-auto-pairs*
+

Yes, and several other fixes on looking at it more:

In the Introduction, "It requires Vim 8 or higher..." is removed given it is shipped with Vim 9.2.
Further quoting stuff is fixed in addition to your ones, above (incl. "rustfmt", "overwrite").
Added *b:rustfmt_autosave* and *b:rustfmt_autosave_if_config_present* tags as those had hot-links applicable text, which is now hot-linked where it is not under the text of the tag itself. (Note the tags file has not been updated, though.)
More wording fixes including, "any parent directory leading to" and "This plugin defines".
Whitespace: It looks fine with no double returns anywhere, so that's been made consistent.

I'll stop getting distracted and conclude my near-finished, mammoth vim9.txt Section 2 + related update now.... Cheers

—
Reply to this email directly, view it on GitHub, or unsubscribe.
You are receiving this because you are subscribed to this thread.

Reply all

Reply to author

Forward