doc refinement

softdevteam · Dec 18, 2023 · 22ca050 · 22ca050
1 parent 505f05c
commit 22ca050
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/lrlex/src/lib/mod.rs b/lrlex/src/lib/mod.rs
@@ -194,7 +194,9 @@ mod unstable {
     pub trait UnstableTrait {}
 }
 
-/// A module for lifting restrictions on visibility of unstable features.
+/// A module for lifting restrictions on visibility by enabling unstable features.
+///
+/// See the sources for a complete list of features, and members.
 pub mod unstable_api {
     /// Unstable functions that take a value `UnstableApi` require
     /// the "_unstable_api" feature. This feature controls
@@ -220,7 +222,7 @@ pub mod unstable_api {
     /// Deriving the trait outside the crate (requires feature `_unsealed_unstable_traits`)
     /// ```
     /// struct Bar;
-    /// impl unstable_api::UnstableTrait for Bar{};
+    /// impl unstable_api::UnstableTrait for Bar{}
     /// impl Foo for Bar {
     ///   fn foo(key: unstable_api::UnstableApi) {
     ///     ...
@@ -242,6 +244,7 @@ pub mod unstable_api {
     /// Access to it does not require any features to be enabled.
     ///
     /// Q. When this should be used?
+    ///
     /// A. When generated code needs to call internal api within it,
     /// where you do not want the caller to have to enable any features
     /// to use the generated code.

diff --git a/lrpar/src/lib/mod.rs b/lrpar/src/lib/mod.rs
@@ -239,7 +239,9 @@ mod unstable {
     pub trait UnstableTrait {}
 }
 
-/// A module for lifting restrictions on visibility of unstable features.
+/// A module for lifting restrictions on visibility by enabling unstable features.
+///
+/// See the sources for a complete list of features, and members.
 pub mod unstable_api {
     /// Unstable functions that take a value `UnstableApi` require
     /// the "_unstable_api" feature. This feature controls
@@ -265,7 +267,7 @@ pub mod unstable_api {
     /// Deriving the trait outside the crate (requires feature `_unsealed_unstable_traits`)
     /// ```
     /// struct Bar;
-    /// impl unstable_api::UnstableTrait for Bar{};
+    /// impl unstable_api::UnstableTrait for Bar{}
     /// impl Foo for Bar {
     ///   fn foo(key: unstable_api::UnstableApi) {
     ///     ...
@@ -287,6 +289,7 @@ pub mod unstable_api {
     /// Access to it does not require any features to be enabled.
     ///
     /// Q. When this should be used?
+    ///
     /// A. When generated code needs to call internal api within it,
     /// where you do not want the caller to have to enable any features
     /// to use the generated code.