Skip to content

Commit 9170ddf

Browse files
committed
Add some internal docs links for Args/ArgsOs
1 parent 59b87b3 commit 9170ddf

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

src/libstd/env.rs

+13-5
Original file line numberDiff line numberDiff line change
@@ -546,17 +546,23 @@ pub fn current_exe() -> io::Result<PathBuf> {
546546
os_imp::current_exe()
547547
}
548548

549-
/// An iterator over the arguments of a process, yielding a `String` value
549+
/// An iterator over the arguments of a process, yielding a [`String`] value
550550
/// for each argument.
551551
///
552-
/// This structure is created through the `std::env::args` method.
552+
/// This structure is created through the [`std::env::args`] method.
553+
///
554+
/// [`String`]: ../string/struct.String.html
555+
/// [`std::env::args`]: ./fn.args.html
553556
#[stable(feature = "env", since = "1.0.0")]
554557
pub struct Args { inner: ArgsOs }
555558

556-
/// An iterator over the arguments of a process, yielding an `OsString` value
559+
/// An iterator over the arguments of a process, yielding an [`OsString`] value
557560
/// for each argument.
558561
///
559-
/// This structure is created through the `std::env::args_os` method.
562+
/// This structure is created through the [`std::env::args_os`] method.
563+
///
564+
/// [`OsString`]: ../ffi/struct.OsString.html
565+
/// [`std::env::args_os`]: ./fn.args_os.html
560566
#[stable(feature = "env", since = "1.0.0")]
561567
pub struct ArgsOs { inner: sys::args::Args }
562568

@@ -571,7 +577,7 @@ pub struct ArgsOs { inner: sys::args::Args }
571577
///
572578
/// The returned iterator will panic during iteration if any argument to the
573579
/// process is not valid unicode. If this is not desired,
574-
/// use the `args_os` function instead.
580+
/// use the [`args_os`] function instead.
575581
///
576582
/// # Examples
577583
///
@@ -583,6 +589,8 @@ pub struct ArgsOs { inner: sys::args::Args }
583589
/// println!("{}", argument);
584590
/// }
585591
/// ```
592+
///
593+
/// [`args_os`]: ./fn.args_os.html
586594
#[stable(feature = "env", since = "1.0.0")]
587595
pub fn args() -> Args {
588596
Args { inner: args_os() }

0 commit comments

Comments
 (0)