Add examples to TyKind::FnDef and TyKind::FnPtr docs #54781
Merged
Conversation
This file contains hidden or 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
| r? @varkor (rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive added the S-waiting-on-review 
varkor reviewed Oct 4, 2018
src/librustc/ty/sty.rs Outdated
| Ref(Region<'tcx>, Ty<'tcx>, hir::Mutability), | ||
| | ||
| /// The anonymous type of a function declaration/definition. Each | ||
| /// function has a unique type. |
There was a problem hiding this comment.
Maybe you could also clarify the output syntax here.
/// The anonymous type of a function declaration/definition. Each /// function has a unique type, which is output (for a function /// named `foo` returning an `i32`) as `fn() -> i32 {foo}`. src/librustc/ty/sty.rs Outdated
| /// ```rust | ||
| /// fn foo() -> i32 { 1 } | ||
| /// | ||
| /// fn hello() { |
There was a problem hiding this comment.
I think you can get away with just writing it on two lines, which saves a little space:
fn foo() -> i32 { 1 } let bar = foo; // bar: fn() -> i32 {foo}
| Thanks for the review, it should be good now 👍 |
| Thanks! @bors r+ rollup |
| 📌 Commit 769b383 has been approved by |
bors added S-waiting-on-bors pietroalbini added a commit to pietroalbini/rust that referenced this pull request Oct 5, 2018
Add examples to `TyKind::FnDef` and `TyKind::FnPtr` docs This adds two examples to the docs of `TyKind::FnDef` and `TyKind::FnPtr`. I found these two types a bit confusing when I learned about them and I think adding these examples might help others.
bors added a commit that referenced this pull request Oct 6, 2018
Rollup of 11 pull requests Successful merges: - #54078 (Expand the documentation for the `std::sync` module) - #54717 (Cleanup rustc/ty part 1) - #54781 (Add examples to `TyKind::FnDef` and `TyKind::FnPtr` docs) - #54787 (Only warn about unused `mut` in user-written code) - #54804 (add suggestion for inverted function parameters) - #54812 (Regression test for #32382.) - #54833 (make `Parser::parse_foreign_item()` return a foreign item or error) - #54834 (rustdoc: overflow:auto doesn't work nicely on small screens) - #54838 (Fix typo in src/libsyntax/parse/parser.rs) - #54851 (Fix a regression in 1.30 by reverting #53564) - #54853 (Remove unneccessary error from test, revealing NLL error.) Failed merges: r? @ghost
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
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.
This adds two examples to the docs of
TyKind::FnDefandTyKind::FnPtr.I found these two types a bit confusing when I learned about them and I think adding these examples might help others.