Skip to content

Provide more useful documentation of conversion methods - #95110

Merged
bors merged 1 commit into
rust-lang:masterfrom
wmstack:patch-1
Mar 20, 2022
Merged

Provide more useful documentation of conversion methods#95110
bors merged 1 commit into
rust-lang:masterfrom
wmstack:patch-1

Conversation

@wmstack

Copy link
Copy Markdown
Contributor

I thought that the documentation for these methods needed to be a bit more explanatory for new users. For advanced users, the comments are relatively unnecessary. I think it would be useful to explain precisely what the method does. As a new user, when you see the into method, where the type is inferred, if you are new you don't even know what you convert to, because it is implicit. I believe this can help new users understand.

I thought that the documentation for these methods needed to be a bit more explanatory for new users. For advanced users, the comments are relatively unnecessary. I think it would be useful to explain precisely what the method does. As a new user, when you see the `into` method, where the type is inferred, if you are new you don't even know what you convert to, because it is implicit. I believe this can help new users understand.
@rust-highfive

Copy link
Copy Markdown
Contributor

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

Please see the contribution instructions for more information.

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Mar 19, 2022
@Dylan-DPC

Copy link
Copy Markdown
Member

r? @Dylan-DPC

@Dylan-DPC

Copy link
Copy Markdown
Member

@bors r+ rollup

@bors

bors commented Mar 19, 2022

Copy link
Copy Markdown
Collaborator

📌 Commit edee46e has been approved by Dylan-DPC

@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 Mar 19, 2022
Dylan-DPC added a commit to Dylan-DPC/rust that referenced this pull request Mar 19, 2022
Provide more useful documentation of conversion methods
I thought that the documentation for these methods needed to be a bit more explanatory for new users. For advanced users, the comments are relatively unnecessary. I think it would be useful to explain precisely what the method does. As a new user, when you see the `into` method, where the type is inferred, if you are new you don't even know what you convert to, because it is implicit. I believe this can help new users understand.
@Dylan-DPCDylan-DPC mentioned this pull request Mar 19, 2022
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this pull request Mar 19, 2022
Provide more useful documentation of conversion methods
I thought that the documentation for these methods needed to be a bit more explanatory for new users. For advanced users, the comments are relatively unnecessary. I think it would be useful to explain precisely what the method does. As a new user, when you see the `into` method, where the type is inferred, if you are new you don't even know what you convert to, because it is implicit. I believe this can help new users understand.
bors added a commit to rust-lang-ci/rust that referenced this pull request Mar 20, 2022
…askrgr
Rollup of 5 pull requests
Successful merges:
- rust-lang#94749 (remove_dir_all: use fallback implementation on Miri)
- rust-lang#94948 (Fix diagnostics for `#![feature(deprecated_suggestion)]`)
- rust-lang#94989 (Add Stream alias for AsyncIterator)
- rust-lang#95108 (Give more details in `Display` for `hir::Target`)
- rust-lang#95110 (Provide more useful documentation of conversion methods)
Failed merges:
r? `@ghost`
`@rustbot` modify labels: rollup
@bors
bors merged commit 9725caf into rust-lang:masterMar 20, 2022
@rustbotrustbot added this to the 1.61.0 milestone Mar 20, 2022
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-borsStatus: Waiting on bors to run and complete tests. Bors will change the label on completion.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants

@wmstack@rust-highfive@Dylan-DPC@bors@dtolnay@rustbot