Skip to content

Commit bac3eb3

Browse files
committed
docs: Raise visibility of 'string' feature
1 parent 2f93c17 commit bac3eb3

File tree

3 files changed

+7
-1
lines changed

3 files changed

+7
-1
lines changed

src/_features.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
//! * **env**: Turns on the usage of environment variables during parsing.
2020
//! * **unicode**: Turns on support for unicode characters (including emoji) in arguments and help messages.
2121
//! * **wrap_help**: Turns on the help text wrapping feature, based on the terminal size.
22-
//! * **string**: Allow runtime generated strings
22+
//! * **string**: Allow runtime generated strings (e.g. with [`Str`][crate::builder::Str]).
2323
//!
2424
//! #### Experimental features
2525
//!

src/builder/os_str.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
use crate::builder::Str;
22

33
/// A UTF-8-encoded fixed string
4+
///
5+
/// **NOTE:** To support dynamic values (i.e. `OsString`), enable the [`string`
6+
/// feature][crate::_features]
47
#[derive(Default, Clone, Eq, PartialEq, PartialOrd, Ord, Hash)]
58
pub struct OsStr {
69
name: Inner,

src/builder/str.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
/// A UTF-8-encoded fixed string
2+
///
3+
/// **NOTE:** To support dynamic values (i.e. `String`), enable the [`string`
4+
/// feature][crate::_features]
25
#[derive(Default, Clone, Eq, PartialEq, PartialOrd, Ord, Hash)]
36
pub struct Str {
47
name: Inner,

0 commit comments

Comments
 (0)