Skip to content

Commit 22ca050

Browse files
committed
doc refinement
1 parent 505f05c commit 22ca050

File tree

2 files changed

+10
-4
lines changed

2 files changed

+10
-4
lines changed

lrlex/src/lib/mod.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,9 @@ mod unstable {
194194
pub trait UnstableTrait {}
195195
}
196196

197-
/// A module for lifting restrictions on visibility of unstable features.
197+
/// A module for lifting restrictions on visibility by enabling unstable features.
198+
///
199+
/// See the sources for a complete list of features, and members.
198200
pub mod unstable_api {
199201
/// Unstable functions that take a value `UnstableApi` require
200202
/// the "_unstable_api" feature. This feature controls
@@ -220,7 +222,7 @@ pub mod unstable_api {
220222
/// Deriving the trait outside the crate (requires feature `_unsealed_unstable_traits`)
221223
/// ```
222224
/// struct Bar;
223-
/// impl unstable_api::UnstableTrait for Bar{};
225+
/// impl unstable_api::UnstableTrait for Bar{}
224226
/// impl Foo for Bar {
225227
/// fn foo(key: unstable_api::UnstableApi) {
226228
/// ...
@@ -242,6 +244,7 @@ pub mod unstable_api {
242244
/// Access to it does not require any features to be enabled.
243245
///
244246
/// Q. When this should be used?
247+
///
245248
/// A. When generated code needs to call internal api within it,
246249
/// where you do not want the caller to have to enable any features
247250
/// to use the generated code.

lrpar/src/lib/mod.rs

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,9 @@ mod unstable {
239239
pub trait UnstableTrait {}
240240
}
241241

242-
/// A module for lifting restrictions on visibility of unstable features.
242+
/// A module for lifting restrictions on visibility by enabling unstable features.
243+
///
244+
/// See the sources for a complete list of features, and members.
243245
pub mod unstable_api {
244246
/// Unstable functions that take a value `UnstableApi` require
245247
/// the "_unstable_api" feature. This feature controls
@@ -265,7 +267,7 @@ pub mod unstable_api {
265267
/// Deriving the trait outside the crate (requires feature `_unsealed_unstable_traits`)
266268
/// ```
267269
/// struct Bar;
268-
/// impl unstable_api::UnstableTrait for Bar{};
270+
/// impl unstable_api::UnstableTrait for Bar{}
269271
/// impl Foo for Bar {
270272
/// fn foo(key: unstable_api::UnstableApi) {
271273
/// ...
@@ -287,6 +289,7 @@ pub mod unstable_api {
287289
/// Access to it does not require any features to be enabled.
288290
///
289291
/// Q. When this should be used?
292+
///
290293
/// A. When generated code needs to call internal api within it,
291294
/// where you do not want the caller to have to enable any features
292295
/// to use the generated code.

0 commit comments

Comments
 (0)