mirror of
https://github.com/nushell/nushell.git
synced 2025-04-14 00:08:20 +02:00
doc: fix broken doc links (#13644)
Some broken doc links I saw when compiling with `cargo +stable doc --no-deps --document-private-items --workspace --open`
This commit is contained in:
parent
dfdb2b5d31
commit
7003b007d5
@ -2,7 +2,7 @@ use chrono::{DateTime, FixedOffset};
|
|||||||
use nu_protocol::{ShellError, Span, Value};
|
use nu_protocol::{ShellError, Span, Value};
|
||||||
use std::hash::{Hash, Hasher};
|
use std::hash::{Hash, Hasher};
|
||||||
|
|
||||||
/// A subset of [`Value`](crate::Value), which is hashable.
|
/// A subset of [`Value`], which is hashable.
|
||||||
/// And it means that we can put the value into something like
|
/// And it means that we can put the value into something like
|
||||||
/// [`HashMap`](std::collections::HashMap) or [`HashSet`](std::collections::HashSet) for further
|
/// [`HashMap`](std::collections::HashMap) or [`HashSet`](std::collections::HashSet) for further
|
||||||
/// usage like value statistics.
|
/// usage like value statistics.
|
||||||
|
@ -506,7 +506,7 @@ pub fn which(name: impl AsRef<OsStr>, paths: &str, cwd: &Path) -> Option<PathBuf
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Returns true if `name` is a (somewhat useful) CMD internal command. The full
|
/// Returns true if `name` is a (somewhat useful) CMD internal command. The full
|
||||||
/// list can be found at https://ss64.com/nt/syntax-internal.html
|
/// list can be found at <https://ss64.com/nt/syntax-internal.html>
|
||||||
fn is_cmd_internal_command(name: &str) -> bool {
|
fn is_cmd_internal_command(name: &str) -> bool {
|
||||||
const COMMANDS: &[&str] = &[
|
const COMMANDS: &[&str] = &[
|
||||||
"ASSOC", "CLS", "ECHO", "FTYPE", "MKLINK", "PAUSE", "START", "VER", "VOL",
|
"ASSOC", "CLS", "ECHO", "FTYPE", "MKLINK", "PAUSE", "START", "VER", "VOL",
|
||||||
|
@ -43,8 +43,8 @@ pub fn compile(working_set: &StateWorkingSet, block: &Block) -> Result<IrBlock,
|
|||||||
}
|
}
|
||||||
|
|
||||||
/// Compiles a [`Block`] in-place into an IR block. This can be used in a nested manner, for example
|
/// Compiles a [`Block`] in-place into an IR block. This can be used in a nested manner, for example
|
||||||
/// by [`compile_if()`], where the instructions for the blocks for the if/else are inlined into the
|
/// by [`compile_if()`][keyword::compile_if], where the instructions for the blocks for the if/else
|
||||||
/// top-level IR block.
|
/// are inlined into the top-level IR block.
|
||||||
fn compile_block(
|
fn compile_block(
|
||||||
working_set: &StateWorkingSet,
|
working_set: &StateWorkingSet,
|
||||||
builder: &mut BlockBuilder,
|
builder: &mut BlockBuilder,
|
||||||
|
@ -79,7 +79,7 @@ impl PluginProcess {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Move the plugin process out of the foreground. See [`ForegroundGuard::reset`].
|
/// Move the plugin process out of the foreground. See [`ForegroundGuard`].
|
||||||
///
|
///
|
||||||
/// This is a no-op if the plugin process was already in the background.
|
/// This is a no-op if the plugin process was already in the background.
|
||||||
pub(crate) fn exit_foreground(&self) -> Result<(), ShellError> {
|
pub(crate) fn exit_foreground(&self) -> Result<(), ShellError> {
|
||||||
|
@ -11,7 +11,7 @@ pub struct PluginSource {
|
|||||||
/// A weak reference to the persistent plugin that might hold an interface to the plugin.
|
/// A weak reference to the persistent plugin that might hold an interface to the plugin.
|
||||||
///
|
///
|
||||||
/// This is weak to avoid cyclic references, but it does mean we might fail to upgrade if
|
/// This is weak to avoid cyclic references, but it does mean we might fail to upgrade if
|
||||||
/// the engine state lost the [`PersistentPlugin`] at some point.
|
/// the engine state lost the [`PersistentPlugin`][crate::PersistentPlugin] at some point.
|
||||||
pub(crate) persistent: Weak<dyn GetPlugin>,
|
pub(crate) persistent: Weak<dyn GetPlugin>,
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -1,5 +1,5 @@
|
|||||||
/// Like [`Cow`] but with a mutable reference instead. So not exactly clone-on-write, but can be
|
/// Like [`Cow`][std::borrow::Cow] but with a mutable reference instead. So not exactly
|
||||||
/// made owned.
|
/// clone-on-write, but can be made owned.
|
||||||
pub enum MutableCow<'a, T> {
|
pub enum MutableCow<'a, T> {
|
||||||
Borrowed(&'a mut T),
|
Borrowed(&'a mut T),
|
||||||
Owned(T),
|
Owned(T),
|
||||||
|
@ -68,7 +68,7 @@ impl Stack {
|
|||||||
/// stdout and stderr will be set to [`OutDest::Inherit`]. So, if the last command is an external command,
|
/// stdout and stderr will be set to [`OutDest::Inherit`]. So, if the last command is an external command,
|
||||||
/// then its output will be forwarded to the terminal/stdio streams.
|
/// then its output will be forwarded to the terminal/stdio streams.
|
||||||
///
|
///
|
||||||
/// Use [`Stack::capture`] afterwards if you need to evaluate an expression to a [`Value`](crate::Value)
|
/// Use [`Stack::capture`] afterwards if you need to evaluate an expression to a [`Value`]
|
||||||
/// (as opposed to a [`PipelineData`](crate::PipelineData)).
|
/// (as opposed to a [`PipelineData`](crate::PipelineData)).
|
||||||
pub fn new() -> Self {
|
pub fn new() -> Self {
|
||||||
Self {
|
Self {
|
||||||
|
@ -847,7 +847,8 @@ fn truncate_columns_by_head(
|
|||||||
widths
|
widths
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The same as [`tabled::peaker::PriorityMax`] but prioritizes left columns first in case of equal width.
|
/// The same as [`tabled::settings::peaker::PriorityMax`] but prioritizes left columns first in case
|
||||||
|
/// of equal width.
|
||||||
#[derive(Debug, Default, Clone)]
|
#[derive(Debug, Default, Clone)]
|
||||||
pub struct PriorityMax;
|
pub struct PriorityMax;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user