Document possible panics for std::env::{set_var, unset_var}

This commit is contained in:
Tobias Bucher 2015-10-25 12:04:29 +00:00
parent 92dd81ab51
commit 5794950c2d

View file

@ -260,6 +260,11 @@ impl Error for VarError {
/// - [Austin Group Bugzilla](http://austingroupbugs.net/view.php?id=188)
/// - [GNU C library Bugzilla](https://sourceware.org/bugzilla/show_bug.cgi?id=15607#c2)
///
/// # Panics
///
/// This function panics if the `key` string is empty or contains an ASCII
/// equals sign.
///
/// # Examples
///
/// ```
@ -292,6 +297,11 @@ fn _set_var(k: &OsStr, v: &OsStr) {
/// - [Austin Group Bugzilla](http://austingroupbugs.net/view.php?id=188)
/// - [GNU C library Bugzilla](https://sourceware.org/bugzilla/show_bug.cgi?id=15607#c2)
///
/// # Panics
///
/// This function panics if the `key` string is empty or contains an ASCII
/// equals sign.
///
/// # Examples
///
/// ```