Remove double spaces after dots in comments #104505
Conversation
|
r? @jackh726 (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
A-query-system
|
These commits modify compiler targets. Some changes occurred to the CTFE / Miri engine cc @rust-lang/miri Some changes occurred in diagnostic error codes Some changes occurred in compiler/rustc_codegen_cranelift cc @bjorn3 Some changes occurred to the CTFE / Miri engine cc @rust-lang/miri Some changes occurred to MIR optimizations cc @rust-lang/wg-mir-opt Changes rustc_apfloat. rustc_apfloat is currently in limbo and you almost certainly don't want to change it (see #55993). cc @eddyb |
|
I wondered why we have some double white space in some places too. |
|
It wouldn't hurt to have uniformity, but for some people this is a deliberate stylistic choice. I suspect the majority of these are deliberate, not typos. |
|
Interesting. It doesn't have an impact on generated documentation so I guess it's for people reading the source code directly? |
|
@saethlin a lot of these changes happen in comments with multiple sentences, where only a single double space is present, so I don't think majority is deliberate. @GuillaumeGomez most of the changes happen in comments, not doc comments, so these are for source code readers anyway :) |
|
☔ The latest upstream changes (presumably #104600) made this pull request unmergeable. Please resolve the merge conflicts. |
rust-cloud-vms
bot
force-pushed
the
no-double-spaces-in-comments
branch
from
fa05ac6
to
d2b4eaf
Compare
This comment has been minimized.
This comment has been minimized.
rust-cloud-vms
bot
force-pushed
the
no-double-spaces-in-comments
branch
from
d2b4eaf
to
b6f8f0a
Compare
|
So...I'm inclined to think that we shouldn't merge this. First, I've learned that some people have been taught to use two spaces between sentences instead of one. So it's very much possible that many of these are intentional. Second, the difference between one and two spaces visually doesn't make much difference. It also doesn't really hinder the effectiveness of the comments in any way. Third, given point one that these might be intentional, we don't have any style guides or rules for one space vs two. And moreso, we don't have a way to keep new comments from having two spaces between sentences. Given all the above points and that this is kind of touches a lot of files (and I don't think historically we have really sought pull requests for simple stylistic changes), this doesn't really seem like something worth merging. But I'm curious on others' opinions. |
I don't agree, for me it makes a big difference, that's why I've made this pr in in the first place — my eyes caught on the double spaces every time I saw them.
It was proposed that we can grep for something like I do not really have anything to say to other points though. I do think having a stylistic choice here would be nice. But if it's only important for me, then leaving this as is okay. |
|
I'll just cc @rust-lang/compiler for other thoughts then |
|
As long as tidy checks it, and in a way that submodules are ignored, this seems fine to me |
|
☔ The latest upstream changes (presumably #103693) made this pull request unmergeable. Please resolve the merge conflicts. |
|
@WaffleLapkin what do you want to do here? Do you want to make a change to tidy? |
jackh726
added
S-waiting-on-author
|
@jackh726 I'm not sure if it's worth it, given the comments above... But if the tidy check makes sense then I would gladly implement it. |
|
I think writing a tidy check is definitely a good idea. |
|
While I'm very sympathetic to efforts to improve documentation hygiene and style, I don't think we should merge changes to things like formatting that can't be automatically checked by Therefore, if we want to adopt this style, I feel like it should be |
rustbot
added
the
A-testsuite
rust-cloud-vms
bot
force-pushed
the
no-double-spaces-in-comments
branch
2 times, most recently
from
ba8e7f3
to
4156450
Compare
|
I've added a tidy check and removed |
|
☔ The latest upstream changes (presumably #101138) made this pull request unmergeable. Please resolve the merge conflicts. |
rust-cloud-vms
bot
force-pushed
the
no-double-spaces-in-comments
branch
from
4156450
to
bd81463
Compare
|
@Mark-Simulacrum can you review tidy changes? |
|
Can you move the whitespace changes in the tidy commit to the first commit? After that, r=me. |
rust-cloud-vms
bot
force-pushed
the
no-double-spaces-in-comments
branch
from
bd81463
to
7d59c0c
Compare
|
@bors r=jackh726 |
bors
added
S-waiting-on-bors
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#104505 (Remove double spaces after dots in comments) - rust-lang#106784 (prevent E0512 from emitting [type error] by checking the references_error) - rust-lang#106834 (new trait solver: only consider goal changed if response is not identity) - rust-lang#106889 (Mention the lack of `windows_mut` in `windows`) - rust-lang#106963 (Use `scope_expr_id` from `ProbeCtxt`) - rust-lang#106970 (Switch to `EarlyBinder` for `item_bounds` query) - rust-lang#106980 (Hide `_use_mk_alias_ty_instead` in `<AliasTy as Debug>::fmt`) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
Most of the comments do not have double spaces, so I assume these are typos.