From: Tobias Bucher <tobiasbucher5991@gmail.com>
Date: Sun, 25 Oct 2015 12:04:29 +0000 (+0000)
Subject: Document possible panics for `std::env::{set_var, unset_var}`
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=5794950c2d81097935a2430a8a06ba43fe3c4049;p=rust.git

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

diff --git a/src/libstd/env.rs b/src/libstd/env.rs
index 518c67bbe7f..685139a7fc1 100644
--- a/src/libstd/env.rs
+++ b/src/libstd/env.rs
@@ -260,6 +260,11 @@ fn description(&self) -> &str {
 ///  - [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
 ///
 /// ```