From cd7ab9a1d65404496422d6f559153ecca4edcb24 Mon Sep 17 00:00:00 2001 From: AlexKnauth Date: Wed, 13 Dec 2023 18:23:32 -0500 Subject: [PATCH] Document filter `;` semicolons --- crates/livesplit-auto-splitting/README.md | 3 ++- crates/livesplit-auto-splitting/src/lib.rs | 3 ++- crates/livesplit-auto-splitting/src/settings/gui.rs | 5 +++-- src/auto_splitting/mod.rs | 3 ++- 4 files changed, 9 insertions(+), 5 deletions(-) diff --git a/crates/livesplit-auto-splitting/README.md b/crates/livesplit-auto-splitting/README.md index 61a800a3..1780914b 100644 --- a/crates/livesplit-auto-splitting/README.md +++ b/crates/livesplit-auto-splitting/README.md @@ -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( diff --git a/crates/livesplit-auto-splitting/src/lib.rs b/crates/livesplit-auto-splitting/src/lib.rs index 09bfe255..7886a05b 100644 --- a/crates/livesplit-auto-splitting/src/lib.rs +++ b/crates/livesplit-auto-splitting/src/lib.rs @@ -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( diff --git a/crates/livesplit-auto-splitting/src/settings/gui.rs b/crates/livesplit-auto-splitting/src/settings/gui.rs index d17e77e9..4428dedc 100644 --- a/crates/livesplit-auto-splitting/src/settings/gui.rs +++ b/crates/livesplit-auto-splitting/src/settings/gui.rs @@ -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, }, } diff --git a/src/auto_splitting/mod.rs b/src/auto_splitting/mod.rs index 8a73c9b6..5e5255ad 100644 --- a/src/auto_splitting/mod.rs +++ b/src/auto_splitting/mod.rs @@ -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(