Skip to content

Commit

Permalink
Ignore doctests on private items
Browse files Browse the repository at this point in the history
  • Loading branch information
Heliozoa committed Jun 1, 2023
1 parent adb8d1a commit 9a7e25e
Show file tree
Hide file tree
Showing 5 changed files with 6 additions and 9 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Only hard requirement is that all tags which are used to create release builds *

## Formatting

Code should be formatted with [`cargo fmt`](https://github.com/rust-lang/rustfmt) and linted with [`cargo clippy`](https://github.com/rust-lang/rust-clippy).
Code should be formatted with [`cargo +nightly fmt`](https://github.com/rust-lang/rustfmt) and linted with [`cargo clippy`](https://github.com/rust-lang/rust-clippy).

## Releasing a new version

Expand Down
2 changes: 2 additions & 0 deletions rustfmt.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
imports_granularity="Crate"
group_imports="One"
5 changes: 0 additions & 5 deletions rustfmt.toml.disabled

This file was deleted.

2 changes: 1 addition & 1 deletion src/interactive/prompt.rs
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const POLL_RATE: u64 = 1000;
/// display an interactive prompt to ask the user to select an item
///
/// example:
/// ```
/// ```ignore
/// let prompt = "Choose your organization:";
/// let items = vec![String::from("Eka"), String::from("Toka"), String::from("Kolmas"),
/// String::from("Neljäs")];
Expand Down
4 changes: 2 additions & 2 deletions src/interactive/state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,8 @@ impl<'a, T: Clone> StatefulList<'a, T> {
///
/// Example:
///
/// ```
/// ```ignore
/// # use tmc::interactive::state::AppState;
/// let items = &["Eka", "Toka", "Kolmas"];
/// let mut app = AppState::new(items);
///
Expand Down Expand Up @@ -140,7 +141,6 @@ impl<'a> AppState<'a> {

#[cfg(test)]
mod tests {

use super::AppState;

fn get_item_list() -> &'static [&'static str] {
Expand Down

0 comments on commit 9a7e25e

Please sign in to comment.