Primitive docs relevant #48152

antoyo · 2018-02-12T03:01:06Z

This fixes the documentation to show the right types in the examples for many integer methods.

I need to check if the result is correct before we merge.

antoyo · 2018-02-12T03:01:14Z

rust-highfive · 2018-02-12T03:01:17Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @joshtriplett (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

joshtriplett · 2018-02-12T05:46:38Z

src/libcore/num/mod.rs

+```
+let n = 0b01001100", stringify!($SelfT), ";
+
+assert_eq!(n.count_zeros(), 5);


This doesn't seem right; wouldn't the number of zeroes depend on the size of the type? It should be the number of bits in the type minus 3.

It would indeed!

joshtriplett · 2018-02-12T06:10:52Z

src/libcore/num/mod.rs

@@ -1436,33 +1446,35 @@ macro_rules! uint_impl {
            unsafe { intrinsics::ctlz(self as $ActualT) as u32 }


Shouldn't the example of leading_zeroes get the same treatment, rather than hardcoding u16?

(And ditto for other methods here whose docs still list specific types in their examples.)

Some methods were left as is because it was hard to make the example generic.

If you can't convert all the examples, I would like to see the "examples are shared between primitive integer types" notice kept on the primitive docs, since it still applies.

GuillaumeGomez · 2018-02-14T00:35:37Z

Should be good now.

GuillaumeGomez · 2018-02-14T09:10:37Z

Tests passed!

QuietMisdreavus

Just a couple notes. Thanks so much for doing this!

QuietMisdreavus · 2018-02-14T16:41:07Z

src/libcore/num/mod.rs

+    int_impl! { i128, i128, u128, 128, -170141183460469231731687303715884105728,
+        170141183460469231731687303715884105727, "#![feature(i128_type)]
+#![feature(i128)]
+# fn main() {


Wait, does this actually need the manual fn main? Rustdoc should move those feature flags outside its generated main function.

Apparently it fails otherwise. I was quite surprised as well...

I wonder if it has to do with line breaks. Did your previous attempt have a line break after the feature flags? I think rustdoc doesn't do anything fancier than "if the line starts with #![, splice out the whole line".

QuietMisdreavus · 2018-02-14T16:48:55Z

src/libcore/num/mod.rs

@@ -1436,33 +1446,35 @@ macro_rules! uint_impl {
            unsafe { intrinsics::ctlz(self as $ActualT) as u32 }


If you can't convert all the examples, I would like to see the "examples are shared between primitive integer types" notice kept on the primitive docs, since it still applies.

QuietMisdreavus · 2018-02-14T19:22:56Z

[00:03:47] error: this file contains an un-closed delimiter
[00:03:47]     --> libcore/num/mod.rs:3756:4
[00:03:47]      |
[00:03:47] 3756 | ];
[00:03:47]      |    ^
[00:03:47]      |
[00:03:47] help: did you mean to close this delimiter?
[00:03:47]     --> libcore/num/mod.rs:1390:24
[00:03:47]      |
[00:03:47] 1390 | macro_rules! uint_impl {
[00:03:47]      |                        ^
[00:03:47] 
[00:03:47] error: no rules expected the token `#`
[00:03:47]     --> libcore/num/mod.rs:2481:1
[00:03:47]      |
[00:03:47] 2481 | #[lang = "u8"]
[00:03:47]      | ^
[00:03:47] 
[00:03:47] error: Could not compile `core`.

QuietMisdreavus · 2018-02-15T14:50:20Z

[01:12:33]    Doc-tests core
[01:12:36] 
[01:12:36] running 1324 tests
<snip>
[01:14:46] failures:
[01:14:46] 
[01:14:46] ---- num/mod.rs - num::u128::leading_zeros (line 107) stdout ----
[01:14:46] 	error[E0658]: 128-bit type is unstable (see issue #35118)
[01:14:46]  --> num/mod.rs:108:9
[01:14:46]   |
[01:14:46] 4 | let n = u128::max_value() >> 2;
[01:14:46]   |         ^^^^^^^^^^^^^^^
[01:14:46]   |
[01:14:46]   = help: add #![feature(i128_type)] to the crate attributes to enable
[01:14:46] 
[01:14:46] thread 'rustc' panicked at 'couldn't compile the test', librustdoc/test.rs:298:13
[01:14:46] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[01:14:46] 
[01:14:46] 
[01:14:46] failures:
[01:14:46]     num/mod.rs - num::u128::leading_zeros (line 107)

QuietMisdreavus · 2018-02-15T16:32:34Z

[01:19:36]    Doc-tests core
[01:19:40] 
[01:19:40] running 1324 tests
<snip>
[01:22:06] failures:
[01:22:06] 
[01:22:06] ---- num/mod.rs - num::u128::leading_zeros (line 107) stdout ----
[01:22:06] 	error: this file contains an un-closed delimiter
[01:22:06]  --> num/mod.rs:114:35
[01:22:06]   |
[01:22:06] 9 | assert_eq!(n.leading_zeros(), 2);
[01:22:06]   |                                   ^
[01:22:06]   |
[01:22:06] help: did you mean to close this delimiter?
[01:22:06]  --> num/mod.rs:111:11
[01:22:06]   |
[01:22:06] 6 | fn main() {
[01:22:06]   |           ^
[01:22:06] 
[01:22:06] thread 'rustc' panicked at 'couldn't compile the test', librustdoc/test.rs:298:13
[01:22:06] note: Run with `RUST_BACKTRACE=1` for a backtrace.
[01:22:06] 
[01:22:06] 
[01:22:06] failures:
[01:22:06]     num/mod.rs - num::u128::leading_zeros (line 107)

QuietMisdreavus · 2018-02-15T23:15:44Z

Looks like we're all set! Thanks so much!

@bors r+

bors · 2018-02-15T23:15:45Z

📌 Commit d692e94 has been approved by QuietMisdreavus

…uietMisdreavus Primitive docs relevant This fixes the documentation to show the right types in the examples for many integer methods. I need to check if the result is correct before we merge.

kennytm · 2018-02-16T14:10:54Z

@bors r-

Unfortunately this PR failed on 32-bit platforms.

[00:03:20] error: unexpected end of macro invocation
[00:03:20]     --> src/libcore/num/mod.rs:1380:42
[00:03:20]      |
[00:03:20] 1380 |     int_impl! { isize, i32, u32, 32, "", "" }
[00:03:20]      |                                          ^^

kennytm · 2018-02-16T14:12:12Z

src/libcore/num/mod.rs

 }

 #[cfg(target_pointer_width = "32")]
 #[lang = "isize"]
 impl isize {
-    int_impl! { isize, i32, u32, 32 }
+    int_impl! { isize, i32, u32, 32, "", "" }


You are missing -2147483648, 2147483647 here. Similar for the 16-bit code at line 1374 above.

Indeed, thanks!

GuillaumeGomez · 2018-02-16T15:32:57Z

Fixed.

@bors: r=QuietMisdreavus

bors · 2018-02-16T15:32:58Z

📌 Commit a58409d has been approved by QuietMisdreavus

…uietMisdreavus Primitive docs relevant This fixes the documentation to show the right types in the examples for many integer methods. I need to check if the result is correct before we merge.

Rollup of 8 pull requests - Successful merges: #48095, #48152, #48234, #48239, #48243, #48260, #48284, #48286 - Failed merges:

GuillaumeGomez and others added 2 commits February 11, 2018 21:53

Make primitive types docs relevant

9931583

Make primitive types docs relevant (unsigned)

56e15de

rust-highfive assigned joshtriplett Feb 12, 2018

rust-highfive assigned QuietMisdreavus and unassigned joshtriplett Feb 12, 2018

joshtriplett reviewed Feb 12, 2018

View reviewed changes

pietroalbini added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Feb 12, 2018

Fix tidy errors

146b81c

GuillaumeGomez force-pushed the primitive-docs-relevant branch 3 times, most recently from 4f202bf to dcc9f74 Compare February 13, 2018 18:39

Add missing feature

9a30673

GuillaumeGomez force-pushed the primitive-docs-relevant branch from dcc9f74 to 9a30673 Compare February 14, 2018 00:35

GuillaumeGomez changed the title ~~[WIP] Primitive docs relevant~~ Primitive docs relevant Feb 14, 2018

QuietMisdreavus reviewed Feb 14, 2018

View reviewed changes

GuillaumeGomez force-pushed the primitive-docs-relevant branch from 57ca76a to 57498e1 Compare February 14, 2018 18:55

GuillaumeGomez force-pushed the primitive-docs-relevant branch from 57498e1 to 4380672 Compare February 14, 2018 23:32

GuillaumeGomez force-pushed the primitive-docs-relevant branch from 4380672 to 4a42042 Compare February 15, 2018 14:54

GuillaumeGomez force-pushed the primitive-docs-relevant branch from 4a42042 to d692e94 Compare February 15, 2018 16:34

bors removed the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Feb 15, 2018

bors added the S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. label Feb 15, 2018

GuillaumeGomez mentioned this pull request Feb 16, 2018

Rollup of 8 pull requests #48261

Closed

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Feb 16, 2018

kennytm reviewed Feb 16, 2018

View reviewed changes

Notify users that this example is shared through integer types

a58409d

GuillaumeGomez force-pushed the primitive-docs-relevant branch from d692e94 to a58409d Compare February 16, 2018 15:32

bors 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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 16, 2018

GuillaumeGomez mentioned this pull request Feb 17, 2018

Rollup of 8 pull requests #48294

Merged

bors added a commit that referenced this pull request Feb 17, 2018

Auto merge of #48294 - GuillaumeGomez:rollup, r=GuillaumeGomez

f6216b2

Rollup of 8 pull requests - Successful merges: #48095, #48152, #48234, #48239, #48243, #48260, #48284, #48286 - Failed merges:

bors merged commit a58409d into rust-lang:master Feb 17, 2018

GuillaumeGomez mentioned this pull request Feb 27, 2018

Add functions for reversing the bit pattern in an integer #48573

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Primitive docs relevant #48152

Primitive docs relevant #48152

antoyo commented Feb 12, 2018

antoyo commented Feb 12, 2018 •

edited

Loading

rust-highfive commented Feb 12, 2018

joshtriplett Feb 12, 2018

GuillaumeGomez Feb 12, 2018

joshtriplett Feb 12, 2018

joshtriplett Feb 12, 2018

antoyo Feb 12, 2018

QuietMisdreavus Feb 14, 2018

GuillaumeGomez commented Feb 14, 2018

GuillaumeGomez commented Feb 14, 2018

QuietMisdreavus left a comment

QuietMisdreavus Feb 14, 2018

GuillaumeGomez Feb 14, 2018

QuietMisdreavus Feb 14, 2018

QuietMisdreavus Feb 14, 2018

QuietMisdreavus commented Feb 14, 2018

QuietMisdreavus commented Feb 15, 2018

QuietMisdreavus commented Feb 15, 2018

QuietMisdreavus commented Feb 15, 2018

bors commented Feb 15, 2018

kennytm commented Feb 16, 2018

kennytm Feb 16, 2018

GuillaumeGomez Feb 16, 2018

GuillaumeGomez commented Feb 16, 2018

bors commented Feb 16, 2018

		@@ -1436,33 +1446,35 @@ macro_rules! uint_impl {
		unsafe { intrinsics::ctlz(self as $ActualT) as u32 }

Primitive docs relevant #48152

Primitive docs relevant #48152

Conversation

antoyo commented Feb 12, 2018

antoyo commented Feb 12, 2018 • edited Loading

rust-highfive commented Feb 12, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Feb 14, 2018

GuillaumeGomez commented Feb 14, 2018

QuietMisdreavus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

QuietMisdreavus commented Feb 14, 2018

QuietMisdreavus commented Feb 15, 2018

QuietMisdreavus commented Feb 15, 2018

QuietMisdreavus commented Feb 15, 2018

bors commented Feb 15, 2018

kennytm commented Feb 16, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GuillaumeGomez commented Feb 16, 2018

bors commented Feb 16, 2018

antoyo commented Feb 12, 2018 •

edited

Loading