doc: std::env::var: Returns None for names with '=' or NUL byte · patricklam/verify-rust-std@9668691 (original) (raw)

Original file line number	Diff line number	Diff line change
@@ -198,13 +198,16 @@ impl fmt::Debug for VarsOs {
198	198	///
199	199	/// # Errors
200	200	///
201		-/// This function will return an error if the environment variable isn't set.
	201	+/// This function returns [`VarError::NotPresent`] if the environment variable
	202	+/// isn't set.
202	203	///
203		-/// This function may return an error if the environment variable's name contains
204		-/// the equal sign character (`=`) or the NUL character.
	204	+/// This function may return [`VarError::NotPresent`] if the
	205	+/// environment variable's name contains the equal sign character (`=`) or the
	206	+/// NUL character.
205	207	///
206		-/// This function will return an error if the environment variable's value is
207		-/// not valid Unicode. If this is not desired, consider using [`var_os`].
	208	+/// This function will return [`VarError::NotUnicode`] if the environment
	209	+/// variable's value is not valid Unicode. If this is not desired, consider
	210	+/// using [`var_os`].
208	211	///
209	212	/// # Examples
210	213	///