Skip to content

Commit

Permalink
Document filter ; semicolons
Browse files Browse the repository at this point in the history
  • Loading branch information
AlexKnauth committed Dec 13, 2023
1 parent e0c786f commit cd7ab9a
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 5 deletions.
3 changes: 2 additions & 1 deletion crates/livesplit-auto-splitting/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,8 @@ extern "C" {
) -> bool;
/// Adds a new file selection setting that the user can modify.
/// This allows the user to select a file path to be stored at the key.
/// The filter can include `*` wildcards, for example `"*.txt"`.
/// The filter can include `*` wildcards, for example `"*.txt"`,
/// and multiple patterns separated by `;` semicolons, like `"*.txt;*.md"`.
/// The pointers need to point to valid UTF-8 encoded text with the
/// respective given length.
pub fn user_settings_add_file_selection(
Expand Down
3 changes: 2 additions & 1 deletion crates/livesplit-auto-splitting/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,8 @@
//! ) -> bool;
//! /// Adds a new file selection setting that the user can modify.
//! /// This allows the user to select a file path to be stored at the key.
//! /// The filter can include `*` wildcards, for example `"*.txt"`.
//! /// The filter can include `*` wildcards, for example `"*.txt"`,
//! /// and multiple patterns separated by `;` semicolons, like `"*.txt;*.md"`.
//! /// The pointers need to point to valid UTF-8 encoded text with the
//! /// respective given length.
//! pub fn user_settings_add_file_selection(
Expand Down
5 changes: 3 additions & 2 deletions crates/livesplit-auto-splitting/src/settings/gui.rs
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,9 @@ pub enum WidgetKind {
},
/// A file selection. This could be a button that opens a File Dialog.
FileSelection {
/// A filter on which files are selectable,
/// for example `"*.txt"` for text files.
/// A filter on which files are selectable.
/// Can include `*` wildcards, for example `"*.txt"`,
/// and multiple patterns separated by `;` semicolons, like `"*.txt;*.md"`.
filter: Arc<str>,
},
}
Expand Down
3 changes: 2 additions & 1 deletion src/auto_splitting/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,8 @@
//! ) -> bool;
//! /// Adds a new file selection setting that the user can modify.
//! /// This allows the user to select a file path to be stored at the key.
//! /// The filter can include `*` wildcards, for example `"*.txt"`.
//! /// The filter can include `*` wildcards, for example `"*.txt"`,
//! /// and multiple patterns separated by `;` semicolons, like `"*.txt;*.md"`.
//! /// The pointers need to point to valid UTF-8 encoded text with the
//! /// respective given length.
//! pub fn user_settings_add_file_selection(
Expand Down

0 comments on commit cd7ab9a

Please sign in to comment.