Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format std::env::consts docstrings with markdown backticks #128535

Merged
merged 3 commits into from
Sep 17, 2024
+107 −66
Merged

Format std::env::consts docstrings with markdown backticks #128535

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8c91a7e
Format std::env::consts docstrings
mmvanheusden Aug 2, 2024
f8d8aa6
Add unordered list with possible values for each const
mmvanheusden Aug 15, 2024
0328c86
Refer to other docs
mmvanheusden Aug 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Loading
Loading status checks…
Format std::env::consts docstrings 
This clarifies possible outputs the constants might be.
@mmvanheusden
mmvanheusden committed Aug 15, 2024

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
Learn about vigilant mode
commit 8c91a7e9abc2b9b053ac9340794de3ee66241035
74 changes: 37 additions & 37 deletions library/std/src/env.rs
View file
Original file line number Diff line number Diff line change
@@ -949,29 +949,29 @@ 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");

/// The family of the operating system. Example value is `unix`.
///
/// 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;