Skip to content

Commit e1fcc93

Browse files
committed
Format std::env::consts docstrings
This clarifies possible outputs the constants might be.
1 parent 1932602 commit e1fcc93

File tree

1 file changed

+37
-37
lines changed

1 file changed

+37
-37
lines changed

library/std/src/env.rs

+37-37
Original file line numberDiff line numberDiff line change
@@ -937,29 +937,29 @@ pub mod consts {
937937
///
938938
/// Some possible values:
939939
///
940-
/// - x86
941-
/// - x86_64
942-
/// - arm
943-
/// - aarch64
944-
/// - loongarch64
945-
/// - m68k
946-
/// - csky
947-
/// - mips
948-
/// - mips64
949-
/// - powerpc
950-
/// - powerpc64
951-
/// - riscv64
952-
/// - s390x
953-
/// - sparc64
940+
/// - `x86`
941+
/// - `x86_64`
942+
/// - `arm`
943+
/// - `aarch64`
944+
/// - `loongarch64`
945+
/// - `m68k`
946+
/// - `csky`
947+
/// - `mips`
948+
/// - `mips64`
949+
/// - `powerpc`
950+
/// - `powerpc64`
951+
/// - `riscv64`
952+
/// - `s390x`
953+
/// - `sparc64`
954954
#[stable(feature = "env", since = "1.0.0")]
955955
pub const ARCH: &str = env!("STD_ENV_ARCH");
956956

957957
/// The family of the operating system. Example value is `unix`.
958958
///
959959
/// Some possible values:
960960
///
961-
/// - unix
962-
/// - windows
961+
/// - `unix`
962+
/// - `windows`
963963
#[stable(feature = "env", since = "1.0.0")]
964964
pub const FAMILY: &str = os::FAMILY;
965965

@@ -968,16 +968,16 @@ pub mod consts {
968968
///
969969
/// Some possible values:
970970
///
971-
/// - linux
972-
/// - macos
973-
/// - ios
974-
/// - freebsd
975-
/// - dragonfly
976-
/// - netbsd
977-
/// - openbsd
978-
/// - solaris
979-
/// - android
980-
/// - windows
971+
/// - `linux`
972+
/// - `macos`
973+
/// - `ios`
974+
/// - `freebsd`
975+
/// - `dragonfly`
976+
/// - `netbsd`
977+
/// - `openbsd`
978+
/// - `solaris`
979+
/// - `android`
980+
/// - `windows`
981981
#[stable(feature = "env", since = "1.0.0")]
982982
pub const OS: &str = os::OS;
983983

@@ -986,7 +986,7 @@ pub mod consts {
986986
///
987987
/// Some possible values:
988988
///
989-
/// - lib
989+
/// - `lib`
990990
/// - `""` (an empty string)
991991
#[stable(feature = "env", since = "1.0.0")]
992992
pub const DLL_PREFIX: &str = os::DLL_PREFIX;
@@ -996,9 +996,9 @@ pub mod consts {
996996
///
997997
/// Some possible values:
998998
///
999-
/// - .so
1000-
/// - .dylib
1001-
/// - .dll
999+
/// - `.so`
1000+
/// - `.dylib`
1001+
/// - `.dll`
10021002
#[stable(feature = "env", since = "1.0.0")]
10031003
pub const DLL_SUFFIX: &str = os::DLL_SUFFIX;
10041004

@@ -1007,9 +1007,9 @@ pub mod consts {
10071007
///
10081008
/// Some possible values:
10091009
///
1010-
/// - so
1011-
/// - dylib
1012-
/// - dll
1010+
/// - `so`
1011+
/// - `dylib`
1012+
/// - `dll`
10131013
#[stable(feature = "env", since = "1.0.0")]
10141014
pub const DLL_EXTENSION: &str = os::DLL_EXTENSION;
10151015

@@ -1018,9 +1018,9 @@ pub mod consts {
10181018
///
10191019
/// Some possible values:
10201020
///
1021-
/// - .exe
1022-
/// - .nexe
1023-
/// - .pexe
1021+
/// - `.exe`
1022+
/// - `.nexe`
1023+
/// - `.pexe`
10241024
/// - `""` (an empty string)
10251025
#[stable(feature = "env", since = "1.0.0")]
10261026
pub const EXE_SUFFIX: &str = os::EXE_SUFFIX;
@@ -1030,7 +1030,7 @@ pub mod consts {
10301030
///
10311031
/// Some possible values:
10321032
///
1033-
/// - exe
1033+
/// - `exe`
10341034
/// - `""` (an empty string)
10351035
#[stable(feature = "env", since = "1.0.0")]
10361036
pub const EXE_EXTENSION: &str = os::EXE_EXTENSION;

0 commit comments

Comments
 (0)