From de42a4cc40e60fb61ef061054164cb0758da92a9 Mon Sep 17 00:00:00 2001 From: Canop Date: Wed, 1 Mar 2023 07:42:51 +0100 Subject: improve nushell function comments --- src/shell_install/nushell.rs | 12 ++++-------- 1 file changed, 4 insertions(+), 8 deletions(-) diff --git a/src/shell_install/nushell.rs b/src/shell_install/nushell.rs index 7863eb5..3d58c90 100644 --- a/src/shell_install/nushell.rs +++ b/src/shell_install/nushell.rs @@ -9,12 +9,8 @@ //! - a line to source the link in ~/.config/nushell/config.nu //! (exact paths depend on XDG variables) //! -//! Please note that this function is in no way perfect: -//! - it doesn't allow other commands than cd -//! -//! More info at -//! https://github.com/Canop/broot/issues/375 -//! https://github.com/Canop/broot/issues/656 +//! Please note that this function doesn't allow other commands than cd, +//! contrary to the similar function of other shells. use { super::{util, ShellInstall}, @@ -30,11 +26,11 @@ const VERSION: &str = "4"; const NU_FUNC: &str = r#" # Launch broot # -# Flags for broot must be between quotes: +# Examples: # > br -hi some/path # > br # > br -sdp -# > br -hi -c "vacheblan.svg;:open_preview" .. +# > br -hi -c "vacheblan.svg;:open_preview" .. # # See https://dystroy.org/broot/install-br/ def-env br [ -- cgit v1.2.3