Skip to content

Commit a16476b

Browse files
committed
Document rust-toolchain channels
1 parent 41599f4 commit a16476b

File tree

4 files changed

+24
-2
lines changed

4 files changed

+24
-2
lines changed

crates/rust-toolchain/src/channel.rs

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,28 @@ pub use beta::Beta;
88
pub use nightly::Nightly;
99
pub use stable::Stable;
1010

11-
/// A Rust [`release channel`].
11+
/// A Rust release [`channel`].
1212
///
1313
/// Does not include the once used `Alpha` release channel, which has not been used post `1.0.0`.
1414
///
1515
/// # Variants
1616
///
1717
/// See also: [`Stable`], [`Beta`] and [`Nightly`].
1818
///
19-
/// [`release channel`]: https://forge.rust-lang.org/#current-release-versions
19+
/// # Reading materials
20+
///
21+
/// - [`rustup concepts: channels`]
22+
/// - [`rust book: how rust is made`]
23+
/// - [`rust forge: rust release channel layout`]
24+
/// - [`rust forge: current rust release versions`]
25+
///
26+
///
27+
/// [`channel`]: https://forge.rust-lang.org/#current-release-versions
28+
/// [`rustup concepts: channels`]: https://rust-lang.github.io/rustup/concepts/channels.html
29+
/// [`rust book: how rust is made`]: https://doc.rust-lang.org/book/appendix-07-nightly-rust.html
30+
/// [`rust forge: rust release channel layout`]: https://forge.rust-lang.org/infra/channel-layout.html#the-rust-release-channel-layout
31+
/// [`rust forge: current rust release versions`]: https://forge.rust-lang.org/#current-release-versions
32+
2033
#[derive(Clone, Debug, Eq, Hash, PartialEq)]
2134
pub enum Channel {
2235
/// The stable release channel

crates/rust-toolchain/src/channel/beta.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
use crate::RustVersion;
22

3+
/// The `Beta` release [`channel`]
4+
///
5+
/// [`channel`]: https://rust-lang.github.io/rustup/concepts/channels.html
36
#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
47
pub struct Beta {
58
pub version: RustVersion,

crates/rust-toolchain/src/channel/nightly.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
use crate::Date;
22

3+
/// The `Nightly` release [`channel`]
4+
///
5+
/// [`channel`]: https://rust-lang.github.io/rustup/concepts/channels.html
36
#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
47
pub struct Nightly {
58
pub date: Date,

crates/rust-toolchain/src/channel/stable.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
use crate::RustVersion;
22

3+
/// The `Stable` release [`channel`]
4+
///
5+
/// [`channel`]: https://rust-lang.github.io/rustup/concepts/channels.html
36
#[derive(Clone, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
47
pub struct Stable {
58
pub version: RustVersion,

0 commit comments

Comments
 (0)