Skip to content

libstd/libcore: fix various typos - #74141

Merged
bors merged 1 commit into
rust-lang:masterfrom
euclio:typos
Jul 23, 2020
Merged

libstd/libcore: fix various typos#74141
bors merged 1 commit into
rust-lang:masterfrom
euclio:typos

Conversation

@euclio

@euclioeuclio commented Jul 8, 2020

Copy link
Copy Markdown
Contributor

No description provided.

@rust-highfive

rust-highfive commented Jul 8, 2020

Copy link
Copy Markdown
Contributor

r? @sfackler

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 8, 2020
pickfire
pickfire reviewed Jul 8, 2020
View reviewed changes
Comment threadsrc/libcore/macros/mod.rs Outdated
}

/// Includes a utf8-encoded file as a string.
/// Includes a UTF-8-encoded file as a string.

@pickfirepickfireJul 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Includes a UTF-8-encoded file as a string.
/// Includes a UTF-8encoded file as a string.

@euclioeuclioJul 8, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will fix, but I'm curious: can you point me towards a grammar reference that indicates that this is the right choice?

@pickfirepickfireJul 8, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not a grammar fix, just a readability fix. I never seen UTF-8 and encoded joined together in my life. I also find multiple - in a paragraph hard to read. Looking at wikipedia, I can find both versions there.

@steveklabniksteveklabnikJul 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So like, the - wasn't even strictly necessary in the first place. For one example of a resource talking about this, see https://apastyle.apa.org/learn/faqs/when-use-hyphen

Basically all of these rules are about clarity. Does the hypen disambiguate, or not? I would argue that it's quite clear without the hyphen.

@steveklabniksteveklabnikJul 8, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I should note that I particularly over-use the hypen (oh my I just did it again in this sentence) so this is very much often my fault in Rust docs, though I didn't author this one...)

@pickfire

pickfire commented Jul 8, 2020

Copy link
Copy Markdown
Contributor

Did you go through this with some kind of type checkers like cargo-spellcheck?

steveklabnik
steveklabnik approved these changes Jul 8, 2020
View reviewed changes

@steveklabniksteveklabnik left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with the one suggestion already made, but otherwise, looks great to me! r=me after that's fixed.

pickfire
pickfire approved these changes Jul 9, 2020
View reviewed changes

@pickfirepickfire left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@euclio

euclio commented Jul 9, 2020

Copy link
Copy Markdown
ContributorAuthor

Did you go through this with some kind of type checkers like cargo-spellcheck?

I made a super hacky custom rustdoc pass that ran a spellchecker over markdown compiled to plain text.

@jyn514jyn514 added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label Jul 23, 2020
@jyn514

jyn514 commented Jul 23, 2020

Copy link
Copy Markdown
Member

@bors r=@steveklabnik rollup=always

@bors

bors commented Jul 23, 2020

Copy link
Copy Markdown
Collaborator

📌 Commit 133e91d has been approved by steveklabnik

@borsbors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 23, 2020
@jyn514

jyn514 commented Jul 23, 2020

Copy link
Copy Markdown
Member

I made a super hacky custom rustdoc pass that ran a spellchecker over markdown compiled to plain text.

Do you mind sharing? That sounds useful :)

@ManishearthManishearth mentioned this pull request Jul 23, 2020
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Jul 23, 2020
@bors
Auto merge ofrust-lang#74667- Manishearth:rollup-s6k59sw, r=Manishe…
2bbfa02
…arth
Rollup of 8 pull requests
Successful merges:
- rust-lang#74141 (libstd/libcore: fix various typos)
- rust-lang#74490 (add a Backtrace::disabled function)
- rust-lang#74548 (one more Path::with_extension example, to demonstrate behavior)
- rust-lang#74587 (Prefer constant over function)
- rust-lang#74606 (Remove Linux workarounds for missing CLOEXEC support)
- rust-lang#74637 (Make str point to primitive page)
- rust-lang#74654 (require type defaults to be after const generic parameters)
- rust-lang#74659 (Improve codegen for unchecked float casts on wasm)
Failed merges:
r? @ghost
@bors
bors merged commit 9be1099 into rust-lang:masterJul 23, 2020
@euclio

euclio commented Jul 23, 2020

Copy link
Copy Markdown
ContributorAuthor

euclio@3b2046e

@pickfire

pickfire commented Jul 23, 2020•
edited
Loading

Copy link
Copy Markdown
Contributor

How do you all find https://github.com/drahnr/cargo-spellcheck? Is it useful?

@euclio@jyn514 Do you think it would be good if we integrate that into tidy?

@jyn514

jyn514 commented Jul 23, 2020•
edited
Loading

Copy link
Copy Markdown
Member

It has a dependency on autotools and libtool which is unfortunate ... could we get them to avoid that somehow?

@jyn514

jyn514 commented Jul 23, 2020

Copy link
Copy Markdown
Member

And it also doesn't work:

$ cargo spellcheck check
Error: Failed to parse manifest file /home/joshua/src/rust/src/bootstrap/Cargo.toml: No such file or directory (os error 2)
$ file /home/joshua/src/rust/src/bootstrap/Cargo.toml
/home/joshua/src/rust/src/bootstrap/Cargo.toml: ASCII text

@euclio

euclio commented Jul 23, 2020•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Yeah, I'm not surprisedcargo spellcheck doesn't work well with rustbuild, but maybe it will with some tweaks. I do think it would be worth integrating some sort of spell checking into libstd/libcore docs, though. Maybe we can open an issue for that to talk more?

@jyn514 The master branch shouldn't have a dependency on autotools anymore. It was getting that from hunspell-sys (which I maintain) and we recently moved the build over to cc.

@jyn514jyn514 mentioned this pull request Jul 23, 2020
Closed
@jyn514

jyn514 commented Jul 23, 2020

Copy link
Copy Markdown
Member

@euclio I opened #74697

@cuvipercuviper added this to the 1.47.0 milestone May 2, 2024
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers
@steveklabniksteveklabniksteveklabnik approved these changes
@pickfirepickfirepickfire approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

@sfacklersfackler

Labels

A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsS-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Milestone

1.47.0

Development

Successfully merging this pull request may close these issues.

8 participants

@euclio@rust-highfive@pickfire@jyn514@bors@steveklabnik@cuviper@sfackler