Document default values for primitive types #43252
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Bikeshedding alternative phrasing: |
|
Shouldn't @rust-highfive assign a reviewer to this PR? Or do I have to do it manually or just wait? |
GuillaumeGomez
requested changes
Jul 16, 2017
| default_impl! { char, '\x00' } | ||
| default_impl! { (), (), "Returns the default value of `()`" } | ||
| default_impl! { bool, false, "Returns the default value of `false`" } | ||
| default_impl! { char, '\x00', "Returns the default value of `\\x00`" } |
There was a problem hiding this comment.
Shouldn't it be "Returns the default value of char which is \\x00?"
| default_impl! { bool, false } | ||
| default_impl! { char, '\x00' } | ||
| default_impl! { (), (), "Returns the default value of `()`" } | ||
| default_impl! { bool, false, "Returns the default value of `false`" } |
There was a problem hiding this comment.
Shouldn't it be "Returns the default value ofbool which is false?"
|
Hum, actually I think it's good as is. The wording is lighter. I'll go for this one then. Thanks! @bors: r+ rollup |
|
📌 Commit caf125f has been approved by |
GuillaumeGomez
approved these changes
Jul 16, 2017
bors
added a commit
that referenced
this pull request
Jul 16, 2017
Document default values for primitive types All primitive types implement the `Default` trait but the documentation just says `Returns the "default value" for a type.` and doesn't give a hint about the actual default value. I think it would be good to document the default values in a proper way. I changed the `default_impl` macro to accept a doc string as a third parameter and use this string to overwrite the documentation of `default()` for each primitive type. The generated documentation now looks like this: 
|
☀️ Test successful - status-appveyor, status-travis |
kennytm
added a commit
to kennytm/rust
that referenced
this pull request
Jul 17, 2017
After rust-lang#43252 is merged, building stage0 libcore with -i (--incremental) flag will cause 17 "Quasi-quoting might make incremental compilation very inefficient: NtExpr(..)" warnings, as in rust-lang#40946. Fixing the warning in rust-lang#40946 will take 12 weeks from now to make into the next stage0, so it is quicker to workaround it in libcore instead.
Mark-Simulacrum
added a commit
to Mark-Simulacrum/rust
that referenced
this pull request
Jul 18, 2017
…n-rustbuild, r=alexcrichton Workaround "Quasi-quoting is inefficient" warning in incremental rustbuild introduced in rust-lang#43252. After rust-lang#43252 is merged, building stage0 libcore with `-i` (`--incremental`) flag will cause 17 "Quasi-quoting might make incremental compilation very inefficient: NtExpr(..)" warnings, as in rust-lang#40946. ``` warning: Quasi-quoting might make incremental compilation very inefficient: NtExpr(..) --> src/libcore/default.rs:133:21 | 133 | #[doc = $doc] | ^^^^ ... 139 | default_impl! { (), (), "Returns the default value of `()`" } | ------------------------------------------------------------- in this macro invocation (× 17) ``` True fix for rust-lang#40946 will take at least 12 weeks from now to make into the next stage0, so it is quicker to workaround it in libcore instead. cc @vbrandl @jseyfried
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All primitive types implement the
Defaulttrait but the documentation just saysReturns the "default value" for a type.and doesn't give a hint about the actual default value. I think it would be good to document the default values in a proper way.I changed the
default_implmacro to accept a doc string as a third parameter and use this string to overwrite the documentation ofdefault()for each primitive type.The generated documentation now looks like this: