From 8c91a7e9abc2b9b053ac9340794de3ee66241035 Mon Sep 17 00:00:00 2001 From: Maarten <50550545+mmvanheusden@users.noreply.github.com> Date: Fri, 2 Aug 2024 11:11:54 +0000 Subject: [PATCH] Format std::env::consts docstrings This clarifies possible outputs the constants might be. --- library/std/src/env.rs | 74 +++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/library/std/src/env.rs b/library/std/src/env.rs index 80890e61471c6..e90f24b16dd68 100644 --- a/library/std/src/env.rs +++ b/library/std/src/env.rs @@ -949,20 +949,20 @@ pub mod consts { /// /// Some possible values: /// - /// - x86 - /// - x86_64 - /// - arm - /// - aarch64 - /// - loongarch64 - /// - m68k - /// - csky - /// - mips - /// - mips64 - /// - powerpc - /// - powerpc64 - /// - riscv64 - /// - s390x - /// - sparc64 + /// - `x86` + /// - `x86_64` + /// - `arm` + /// - `aarch64` + /// - `loongarch64` + /// - `m68k` + /// - `csky` + /// - `mips` + /// - `mips64` + /// - `powerpc` + /// - `powerpc64` + /// - `riscv64` + /// - `s390x` + /// - `sparc64` #[stable(feature = "env", since = "1.0.0")] pub const ARCH: &str = env!("STD_ENV_ARCH"); @@ -970,8 +970,8 @@ pub mod consts { /// /// Some possible values: /// - /// - unix - /// - windows + /// - `unix` + /// - `windows` #[stable(feature = "env", since = "1.0.0")] pub const FAMILY: &str = os::FAMILY; @@ -980,16 +980,16 @@ pub mod consts { /// /// Some possible values: /// - /// - linux - /// - macos - /// - ios - /// - freebsd - /// - dragonfly - /// - netbsd - /// - openbsd - /// - solaris - /// - android - /// - windows + /// - `linux` + /// - `macos` + /// - `ios` + /// - `freebsd` + /// - `dragonfly` + /// - `netbsd` + /// - `openbsd` + /// - `solaris` + /// - `android` + /// - `windows` #[stable(feature = "env", since = "1.0.0")] pub const OS: &str = os::OS; @@ -998,7 +998,7 @@ pub mod consts { /// /// Some possible values: /// - /// - lib + /// - `lib` /// - `""` (an empty string) #[stable(feature = "env", since = "1.0.0")] pub const DLL_PREFIX: &str = os::DLL_PREFIX; @@ -1008,9 +1008,9 @@ pub mod consts { /// /// Some possible values: /// - /// - .so - /// - .dylib - /// - .dll + /// - `.so` + /// - `.dylib` + /// - `.dll` #[stable(feature = "env", since = "1.0.0")] pub const DLL_SUFFIX: &str = os::DLL_SUFFIX; @@ -1019,9 +1019,9 @@ pub mod consts { /// /// Some possible values: /// - /// - so - /// - dylib - /// - dll + /// - `so` + /// - `dylib` + /// - `dll` #[stable(feature = "env", since = "1.0.0")] pub const DLL_EXTENSION: &str = os::DLL_EXTENSION; @@ -1030,9 +1030,9 @@ pub mod consts { /// /// Some possible values: /// - /// - .exe - /// - .nexe - /// - .pexe + /// - `.exe` + /// - `.nexe` + /// - `.pexe` /// - `""` (an empty string) #[stable(feature = "env", since = "1.0.0")] pub const EXE_SUFFIX: &str = os::EXE_SUFFIX; @@ -1042,7 +1042,7 @@ pub mod consts { /// /// Some possible values: /// - /// - exe + /// - `exe` /// - `""` (an empty string) #[stable(feature = "env", since = "1.0.0")] pub const EXE_EXTENSION: &str = os::EXE_EXTENSION;