[doc] note the special type inference handling for shift ops

[llogiq]

This adds a note to the docs about the difference between the shift ops and the corresponding trait methods when it comes to type inference.

[rust-highfive]

r? @joshtriplett

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

[joshtriplett]

Looks like a reasonable documentation update to me. Could I get confirmation from @rust-lang/lang on the accuracy of the comment?

[llogiq]

FWiW, I've also written up a blog post on the distinction and how I happened upon it.

[joshtriplett]

@bors r+ rollup

[bors]

📌 Commit a7e3d85 has been approved by joshtriplett

[Centril]

We might want to avoid the jargon typeck in user facing documentation.

[Centril]

s/typeck/Rust's type checker/

[Centril]

s/typeck/Rust's type checker/

[joshtriplett]

On April 12, 2018 3:53:02 PM PDT, Mazdak Farrokhzad ***@***.***> wrote: Centril commented on this pull request. We probably want to avoid the jargon typeck in user facing documentation. > @@ -315,7 +315,12 @@ macro_rules! bitxor_impl { bitxor_impl! { bool usize u8 u16 u32 u64 u128 isize i8 i16 i32 i64 i128 } -/// The left shift operator `<<`. +/// The left shift operator `<<`. Note that because this trait is implemented +/// for all integer types with multiple right-hand-side types, typeck has s/typeck/Rust's type checker/ > @@ -417,7 +422,12 @@ macro_rules! shl_impl_all { shl_impl_all! { u8 u16 u32 u64 u128 usize i8 i16 i32 i64 isize i128 } -/// The right shift operator `>>`. +/// The right shift operator `>>`. Note that because this trait is implemented +/// for all integer types with multiple right-hand-side types, typeck has s/typeck/Rust's type checker/

Good point!

[llogiq]

@kennytm can I s/typeck/Rust's type checker/ now or would that hinder your rollup?

[kennytm]

@llogiq I've removed this PR from the rollup. Feel free to change anything.

[llogiq]

I've replaced 'typeck' with 'the Rust type checker'. This should now be good to go.

[kennytm]

@bors r=joshtriplett

[bors]

📌 Commit b744e3d has been approved by joshtriplett