-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Add Rust operator link and comments #2998
Add Rust operator link and comments #2998
Conversation
Added comments in front of `...` to make it easier to use the Microsoft Doc's great **Copy** feature. Added links to relevant docs about Rust's `?` operator.
Added comments in front of `...` to make it easier to use the Microsoft Doc's great **Copy** feature. Added links to relevant docs about Rust's `?` operator.
@camerondurham : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
VSCode is not my primary editor and I did not have **Run** set up for Rust. I added a note mentioning how to run the project using the `cargo` CLI from the command prompt as well.
@camerondurham : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
@stevewhims : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
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.
Hi, @camerondurham, and thanks for the PR! :) I've taken your suggestions, with the exception of commenting out the ellipses. Across my docs, I have a number of cases where I show a small piece of source code and then successively build that up over the course of a number of listings. In so doing, in each listing I show only the deltas, and I include enough context to make it clear where the reader should add the delta to their own project. I don't, of course, repeat the entire previous listing + delta. That would take up too much space, and would make it harder to identify the delta. Any "delta" listing isn't meant to compile on its own, so it's not meant to be copy-pasted in its entirety into an entire source code file. The reader can of course use the Copy affordance, if that's convenient. But in many cases it's easier just to select-copy the delta and paste that in to the right place.
Anyway, consequently, to remain consistent with the practice described above (which I use in several places in the C++/WinRT docs), I've set the ellipses back to their sans comment syntax form. Remember that those ellipses are not meant to be source code (which the comment might imply) any more than an ellipsis in a passage of English is meant to be English. In both cases (source code or human language), rather, they're meant to indicate that something has been intentionally elided (with enough context to be clear exactly what has been elided).
Thanks!
Steve
Hi @stevewhims, Thank you for the explanation. I appreciate that you took the time to explain that. This will help me write better docs in the future! |
Awesome! Thanks for your contributions! :) |
Added comments in front of
...
to make it easier to use the Microsoft Doc's great Copy feature without syntax errors. This is a very small change but makes it easier to quickly and lazily copy/paste the codeblock into your local.toml
or.rs
file.Added links to relevant docs about Rust's
?
operator.This tutorial was overall very easy to follow and worked seamlessly for me. Thanks for the great job making it easy to get started with Rust on Windows!