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

rust-lang · Oct 25, 2015 · 5794950 · 5794950
1 parent 92dd81a
commit 5794950
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/src/libstd/env.rs b/src/libstd/env.rs
@@ -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
 ///
 /// ```