Document std::env::const values #25668
Conversation
|
(rust_highfive has picked a reviewer for you, use r? to override) |
| /// - dragonfly | ||
| /// - bitrig | ||
| /// - openbsd | ||
| /// - android |
There was a problem hiding this comment.
Missing something for windows?
There was a problem hiding this comment.
whoops, that was the last line of my git grep, accidentally deleted it
|
Should we say that the set of possible values can change (grow) in the future? |
|
That's always true of a non-enum, though. |
|
Looks good to me, thanks @steveklabnik! I agree with @bluss though that the phrasing may want to indicate that it's not an exhaustive list (e.g. I don't want a bug to be opened saying that the documentation disagrees with the implementation). Perhaps something like "Some possible values:" in the sense that the "Some" indicates that this is just a subset. |
|
Other than that though r=me |
|
@bors: r=alexcrichton rollup |
|
📌 Commit 04c7b82 has been approved by |
| /// Some possible values: | ||
| /// | ||
| /// - unix | ||
| /// - windows | ||
| #[stable(feature = "env", since = "1.0.0")] | ||
| pub const FAMILY: &'static str = super::os::FAMILY; | ||
|
|
||
| /// A string describing the specific operating system in use: in this | ||
| /// case, `linux`. |
There was a problem hiding this comment.
Is this a leftover? I don't think this documentation is Linux-specific.
There was a problem hiding this comment.
The documentation is currently built on Linux, and so all of these examples have something like this.
There was a problem hiding this comment.
Is this file generated by some script? Otherwise this should probably be changed.
No description provided.