fixed doc errors

This commit is contained in:
Lutetium-Vanadium 2022-06-04 18:48:06 +05:30
parent d58f4903c0
commit d704892479
3 changed files with 15 additions and 7 deletions

View File

@ -105,7 +105,7 @@ impl<P, B: Backend> Input<P, B> {
/// What to do after receiving a `Esc`.
///
/// For [`OnEsc::Terminate`] - an [`Error::Aborted`](error::Error::Aborted) will be returned.
/// For [`OnEsc::Terminate`] - an [`Error::Aborted`](error::ErrorKind::Aborted) will be returned.
/// For [`OnEsc::SkipQuestion`] - the currently shown prompt will be cleared, and `Ok(None)`
/// will be returned.
/// For [`OnEsc::Ignore`] - no special behaviour will be applied to the `Esc` key. Like other

View File

@ -2,7 +2,7 @@
//!
//! There are 2 default [`SymbolSet`]s -- [`UNICODE`] and [`ASCII`]. If a particular [`SymbolSet`]
//! is not set, [`UNICODE`] is used. The [`ASCII`] symbol set exists if you want to have larger
//! compatibility with terminal emulators (such as Windows' `cmd.exe`) as it exclusively used ASCII
//! compatibility with terminal emulators (such as Windows' `cmd.exe`) which do not support unicode
//! characters.
use std::sync::Mutex;
@ -15,15 +15,17 @@ static SET: Lazy<Mutex<SymbolSet>> = Lazy::new(|| Mutex::new(UNICODE));
///
/// If not set, it defaults to the [`UNICODE`] symbol set.
///
/// Also see [`set`].
/// Also see [`symbols::set`](set).
///
/// # Example
///
/// ```no_run
/// # #[cfg(feature = "ignore this line for doc test as requestty_ui should be used")]
/// use requestty::symbols;
/// # use requestty_ui::symbols;
///
/// let symbol_set = symbols::current();
/// println!(symbol_set.pointer);
/// println!("{}", symbol_set.pointer);
/// ```
pub fn current() -> SymbolSet {
SET.lock().expect("symbol set poisoned").clone()
@ -31,20 +33,23 @@ pub fn current() -> SymbolSet {
/// Set the current [`SymbolSet`]
///
/// Also see [`current`].
/// Also see [`symbols::current`](current).
///
/// # Example
///
/// ```no_run
/// ```
/// # #[cfg(feature = "ignore this line for doc test as requestty_ui should be used")]
/// use requestty::symbols;
/// # use requestty_ui::symbols;
///
/// symbols::set(symbols::ASCII);
/// assert_eq!(symbols::current(), symbols::ASCII);
/// ```
pub fn set(new: SymbolSet) {
*SET.lock().expect("symbol set poisoned") = new;
}
#[derive(Debug, Clone)]
#[derive(Debug, Clone, PartialEq, Eq)]
/// The various special symbols used by the prompts during rendering.
pub struct SymbolSet {
/// Used to point to a special item.

View File

@ -102,6 +102,9 @@ macro_rules! impl_options_builder {
///
/// If it is not given, it defaults to [`OnEsc::Ignore`].
///
/// [`OnEsc`]: ui::OnEsc
/// [`OnEsc::Ignore`]: ui::OnEsc::Ignore
/// [`Answers`]: crate::Answers
///
$(#[$on_esc_meta])*
pub fn on_esc<T>(mut self, on_esc: T) -> Self