8000 Extend and tweak documention in select.rs and theme.rs. by grunweg · Pull Request #177 · console-rs/dialoguer · GitHub
[go: up one dir, main page]
Skip to content

Extend and tweak documention in select.rs and theme.rs. #177

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: master
Choose a base branch
from
Open

Extend and tweak documention in select.rs and theme.rs. #177

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
332c49e
Two typo fixes.
grunweg Jan 20, 2022
9c9ed0e
doc: use imperative tense more in render.rs.
grunweg Feb 14, 2022
86ebe75
doc: Use imperative tense in select.rs.
grunweg Feb 14, 2022
7426264
doc: Reword some doc comments in select.rs.
grunweg Feb 14, 2022
c2cc7c5
doc: minor and grammar improvements in theme.rs.
grunweg Feb 14, 2022
8000 0d28b43
Document some members in select.rs.
grunweg Feb 14, 2022
684a08a
doc: use imperative tense more in confirm.rs.
grunweg May 5, 2022
cdbab55
doc: copy-edit some doc comments in confirm.rs.
grunweg May 5, 2022
13a2153
doc: Document members of the Confirm struct.
grunweg May 5, 2022
1875fe5
doc: Use imperative tense more in theme.rs.
grunweg May 5, 2022
537fd91
doc: use imperative tense in password.rs.
grunweg May 5, 2022
623acf8
doc: document members of password.rs.
grunweg May 5, 2022
7827056
doc: document four functions in theme.rs.
grunweg May 5, 2022
497de38
refactor: use prompts_reset_heights=true in password prompt.
grunweg May 5, 2022
f1dfaa1
refactor: remove prompts_reset_height: it's always true now.
grunweg May 5, 2022
cb1ae52
doc: document meaning of height and prompt_height in TermThemeRenderer.
grunweg May 6, 2022
14a70e1
Merge branch 'master' into more-docs
grunweg May 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8000
Prev Previous commit
Next Next commit
doc: use imperative tense more in render.rs.
  • Loading branch information
@grunweg
grunweg committed Feb 14, 2022
commit 9c9ed0ee153808d61af89550ba45ec4e0d6f5563
34 changes: 17 additions & 17 deletions src/theme.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ use console::{style, Style, StyledObject, Term};

/// Implements a theme for dialoguer.
pub trait Theme {
/// Formats a prompt.
/// Format a prompt.
#[inline]
fn format_prompt(&self, f: &mut dyn fmt::Write, prompt: &str) -> fmt::Result {
write!(f, "{}:", prompt)
}

/// Formats out an error.
/// Format out an error.
#[inline]
fn format_error(&self, f: &mut dyn fmt::Write, err: &str) -> fmt::Result {
write!(f, "error: {}", err)
}

/// Formats a confirm prompt.
/// Format a confirmation prompt.
fn format_confirm_prompt(
&self,
f: &mut dyn fmt::Write,
Expand All @@ -35,7 +35,7 @@ pub trait Theme {
Ok(())
}

/// Formats a confirm prompt after selection.
/// Format a confirmation prompt after selection.
fn format_confirm_prompt_selection(
&self,
f: &mut dyn fmt::Write,
Expand All @@ -58,7 +58,7 @@ pub trait Theme {
}
}

/// Formats an input prompt.
/// Format an input prompt.
fn format_input_prompt(
&self,
f: &mut dyn fmt::Write,
Expand All @@ -72,7 +72,7 @@ pub trait Theme {
}
}

/// Formats an input prompt after selection.
/// Format an input prompt after selection.
#[inline]
fn format_input_prompt_selection(
&self,
Expand All @@ -83,14 +83,14 @@ pub trait Theme {
write!(f, "{}: {}", prompt, sel)
}

/// Formats a password prompt.
/// Format a password prompt.
#[inline]
#[cfg(feature = "password")]
fn format_password_prompt(&self, f: &mut dyn fmt::Write, prompt: &str) -> fmt::Result {
self.format_input_prompt(f, prompt, None)
}

/// Formats a password prompt after selection.
/// Format a password prompt after selection.
#[inline]
#[cfg(feature = "password")]
fn format_password_prompt_selection(
Expand All @@ -101,13 +101,13 @@ pub trait Theme {
self.format_input_prompt_selection(f, prompt, "[hidden]")
}

/// Formats a select prompt.
/// Format a select prompt.
#[inline]
fn format_select_prompt(&self, f: &mut dyn fmt::Write, prompt: &str) -> fmt::Result {
self.format_prompt(f, prompt)
}

/// Formats a select prompt after selection.
/// Format a select prompt after selection.
#[inline]
fn format_select_prompt_selection(
&self,
Expand All @@ -118,19 +118,19 @@ pub trait Theme {
self.format_input_prompt_selection(f, prompt, sel)
}

/// Formats a multi select prompt.
/// Format a multi select prompt.
#[inline]
fn format_multi_select_prompt(&self, f: &mut dyn fmt::Write, prompt: &str) -> fmt::Result {
self.format_prompt(f, prompt)
}

/// Formats a sort prompt.
/// Format a sort prompt.
#[inline]
fn format_sort_prompt(&self, f: &mut dyn fmt::Write, prompt: &str) -> fmt::Result {
self.format_prompt(f, prompt)
}

/// Formats a multi_select prompt after selection.
/// Format a multi_select prompt after selection.
fn format_multi_select_prompt_selection(
&self,
f: &mut dyn fmt::Write,
Expand All @@ -144,7 +144,7 @@ pub trait Theme {
Ok(())
}

/// Formats a sort prompt after selection.
/// Format a sort prompt after selection.
#[inline]
fn format_sort_prompt_selection(
&self,
Expand All @@ -155,7 +155,7 @@ pub trait Theme {
self.format_multi_select_prompt_selection(f, prompt, selections)
}

/// Formats a select prompt item.
/// Format a select prompt item.
fn format_select_prompt_item(
&self,
f: &mut dyn fmt::Write,
Expand Down Expand Up @@ -186,7 +186,7 @@ pub trait Theme {
)
}

/// Formats a sort prompt item.
/// Format a sort prompt item.
fn format_sort_prompt_item(
&self,
f: &mut dyn fmt::Write,
Expand All @@ -206,7 +206,7 @@ pub trait Theme {
)
}

/// Formats a fuzzy select prompt.
/// Format a fuzzy select prompt.
#[cfg(feature = "fuzzy-select")]
fn format_fuzzy_select_prompt(
&self,
Expand Down
0