diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ed41849c7bb..9c80815f516 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -77,7 +77,7 @@ Note: We have not yet determined the End-of-Life schedule for previous major ver ### Verifying Changes A common (sub)set of commands for verifying your change: -```sh +```console $ make test-full $ make clippy-full $ make doc diff --git a/clap_complete/examples/completion-derive.rs b/clap_complete/examples/completion-derive.rs index da3a914bf12..9f1a55d7d15 100644 --- a/clap_complete/examples/completion-derive.rs +++ b/clap_complete/examples/completion-derive.rs @@ -1,16 +1,16 @@ //! How to use value hints and generate shell completions. //! //! Usage with zsh: -//! ```sh -//! cargo run --example completion-derive -- --generate=zsh > /usr/local/share/zsh/site-functions/_completion_derive -//! compinit -//! ./target/debug/examples/completion_derive -- +//! ```console +//! $ cargo run --example completion-derive -- --generate=zsh > /usr/local/share/zsh/site-functions/_completion_derive +//! $ compinit +//! $ ./target/debug/examples/completion_derive -- //! ``` //! fish: -//! ```sh -//! cargo run --example completion-derive -- --generate=fish > completion_derive.fish -//! . ./completion_derive.fish -//! ./target/debug/examples/completion_derive -- +//! ```console +//! $ cargo run --example completion-derive -- --generate=fish > completion_derive.fish +//! $ . ./completion_derive.fish +//! $ ./target/debug/examples/completion_derive -- //! ``` use clap::{Args, Command, CommandFactory, Parser, Subcommand, ValueHint}; use clap_complete::{generate, Generator, Shell}; diff --git a/clap_complete/examples/completion.rs b/clap_complete/examples/completion.rs index 4c66610697b..08905425954 100644 --- a/clap_complete/examples/completion.rs +++ b/clap_complete/examples/completion.rs @@ -1,16 +1,16 @@ //! Example to test arguments with different ValueHint values. //! //! Usage with zsh: -//! ```sh -//! cargo run --example completion -- --generate=zsh > /usr/local/share/zsh/site-functions/_completion -//! compinit -//! ./target/debug/examples/completion -- +//! ```console +//! $ cargo run --example completion -- --generate=zsh > /usr/local/share/zsh/site-functions/_completion$ +//! $ compinit +//! $ ./target/debug/examples/completion -- //! ``` //! fish: -//! ```sh -//! cargo run --example completion -- --generate=fish > completion.fish -//! . ./completion.fish -//! ./target/debug/examples/completion -- +//! ```console +//! $ cargo run --example completion -- --generate=fish > completion.fish +//! $ . ./completion.fish +//! $ ./target/debug/examples/completion -- //! ``` use clap::{value_parser, Arg, Command, ValueHint}; use clap_complete::{generate, Generator, Shell}; diff --git a/clap_complete/src/generator/mod.rs b/clap_complete/src/generator/mod.rs index c025697edfa..c766508e019 100644 --- a/clap_complete/src/generator/mod.rs +++ b/clap_complete/src/generator/mod.rs @@ -217,7 +217,7 @@ where /// /// Usage: /// -/// ```shell +/// ```console /// $ myapp generate-bash-completions > /usr/share/bash-completion/completions/myapp.bash /// ``` pub fn generate(gen: G, cmd: &mut clap::Command, bin_name: S, buf: &mut dyn Write)