Minor rewrite of env::current_exe docs; clarify symlinks. #46987
Conversation
- Update example in ‘security’ section to use hard links, like the linked securityvulns.com example. - Weaken language on symbolic links – indicate behavior is platform-specific Fixes rust-lang#43617.
|
r? @TimNN (rust_highfive has picked a reviewer for you, use r? to override) |
| /// | ||
| /// ```bash | ||
| /// $ ln foo bar | ||
| /// ``` | ||
| /// | ||
| /// When you run it, you won't get the original executable, you'll get the |
There was a problem hiding this comment.
Was the change from ' to ’ deliberate? (Not sure what the convention is here).
There was a problem hiding this comment.
deliberate but not something i feel strongly about. figure the line is already changing so i'm not ruining the diff in any way, but i'm fine keeping as-is
There was a problem hiding this comment.
I don't mind much either way however it looks like ' is used a lot more than ’ in the existing doc comments, so my personal vote would be to keep ' for consistency (but feel free to keep this as-is to get a second opinion).
There was a problem hiding this comment.
’ is the preferred symbol to use for apostrophe in english text according to the Unicode standard. ' is more commonplace because people can’t always be bothered to type Unicode symbols.
My personal vote is to follow the preferences set forth by the standard (I myself try to type unicode ’), but is not something I would bug other people about whether they do or don’t follow the practice.
There was a problem hiding this comment.
In all the docs i've written, i've just used the regular ' because ’ is impossible to type on US-layout keyboards without a software compose key or other kind of software text replacement. On the other hand, the difference is likely too small to notice unless it was inconsistent within a single page. So here it's probably fine, but i wouldn't go using it on other pages without grabbing all the others on the same page like you did here. (And then possibly creating a tidy lint for it so we can keep on top of it. >_>)
|
Looks good to me apart from the comment, however I'm unfamiliar with the current style conventions around Rust docs, so |
kennytm
added
S-waiting-on-review
|
ping @steveklabnik (or @rust-lang/docs), mind taking a look? |
|
Seems good for me. |
|
Looks good to me. The comment about @bors r+ rollup |
|
📌 Commit 17380f2 has been approved by |
…ietMisdreavus Minor rewrite of env::current_exe docs; clarify symlinks. - Update example in ‘security’ section to use hard links, like the linked securityvulns.com example. - Weaken language on symbolic links – indicate behavior is platform-specific Fixes rust-lang#43617.
linked securityvulns.com example.
platform-specific
Fixes #43617.