-
Notifications
You must be signed in to change notification settings - Fork 12.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Document From trait for Option implementations #71909
Conversation
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @LukasKalbertodt (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. |
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
The job Click to expand the log.
I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact |
So I have found 2 errors in my docs where I wrote the:
I have fixed both, but the build pipeline still fails and I don't know what's the cause. I'd appreciate if anyone could help :D |
Co-authored-by: Timo <timorcb@gmail.com>
Thank you very much for helping @timotree3 . It successfully builds now! And I get what you say. So if a method is an implementation of something, the linker cannot resolve relative links even when they're supposedly in the same file? Or it only applies to the |
You're very welcome :)
Yeah more or less. When you put a relative link into rust documentation it resolves based on where it gets rendered. Usually that's only on one page, but in this case, because we're implementing a trait, that's two places: The relative link Does that make it clearer? P.S. "Linker" means something else entirely. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey there! Thanks so much for this PR. I'm glad you got the linking bits sorted.
I have a few suggestions for formatting, and one for re-wording, to make these more consistent. With those changes, "r=me" as we say, which means I'm happy to see this merged.
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
Co-authored-by: Steve Klabnik <steve@steveklabnik.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks so much!
@bors: r+ rollup
Oops, I forgot bors doesn't listen to review comments. @bors: r+ rollup |
📌 Commit 6c3856f has been approved by |
Glad to help! I'll have the formats in mind for next time :D |
Rollup of 12 pull requests Successful merges: - rust-lang#71525 (`prefix` should not be mutable.) - rust-lang#71741 (Pointer printing: do not print 0 offset) - rust-lang#71870 (Be slightly more precise about any::type_name()'s guarantees.) - rust-lang#71909 (Document From trait for Option implementations) - rust-lang#71964 (Fix bootstrap failing on win32) - rust-lang#72137 (Clean up E0581 explanation) - rust-lang#72138 (Add doc comment for `rustc_middle::mir::mono::Linkage`) - rust-lang#72150 (Remove UnnormalizedProjection) - rust-lang#72151 (Update books) - rust-lang#72163 (docs: remove comment referencing non-existent method) - rust-lang#72169 (Clean up E0582 explanation) - rust-lang#72183 (Fix Arc::decr_strong_count doc test) Failed merges: r? @ghost
Add documentation for
From
trait forstd::option::Option
implementationsThis PR solves a part of #51430 ( CC @skade )
This is my first PR ever in contributing for OSS. I'm happy to learn and make any changes if necessary :)