extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-18 06:20:23 +02:00
Code Issues Packages Projects Releases Wiki Activity

Misc doc fixes (#12266)

Browse Source 
# Description

Just a bunch of miscellaneous fixes to the Rust documentation that I
found recently while doing
a pass on some things.

# User-Facing Changes
None
This commit is contained in:
Devyn Cairns
2024-03-23 05:26:08 -07:00
committed by GitHub
parent cc8f2b6419
commit ff41cf91ef
14 changed files with 32 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
crates/nu-plugin/src/protocol/evaluated_call.rs
View File

@@ -9,9 +9,9 @@ use serde::{Deserialize, Serialize};
/// A representation of the plugin's invocation command including command line args
///
/// The `EvaluatedCall` contains information about the way a [Plugin](crate::Plugin) was invoked
/// The `EvaluatedCall` contains information about the way a [`Plugin`](crate::Plugin) was invoked
/// representing the [`Span`] corresponding to the invocation as well as the arguments
/// it was invoked with. It is one of three items passed to [`run`](crate::Plugin::run()) along with
/// it was invoked with. It is one of three items passed to [`run()`](crate::PluginCommand::run()) along with
/// `name` which command that was invoked and a [`Value`] that represents the input.
///
/// The evaluated call is used with the Plugins because the plugin doesn't have

4
crates/nu-plugin/src/protocol/mod.rs
View File

@@ -353,7 +353,7 @@ pub enum PluginOption {
GcDisabled(bool),
}
/// This is just a serializable version of [std::cmp::Ordering], and can be converted 1:1
/// This is just a serializable version of [`std::cmp::Ordering`], and can be converted 1:1
#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
pub enum Ordering {
Less,
@@ -505,7 +505,7 @@ impl<D> EngineCall<D> {
}
}
/// The response to an [EngineCall]. The type parameter determines the output type for pipeline
/// The response to an [`EngineCall`]. The type parameter determines the output type for pipeline
/// data.
#[derive(Serialize, Deserialize, Debug, Clone)]
pub enum EngineCallResponse<D> {