Doccomment style fixes

Cool that clippy can catch those now!
This commit is contained in:
sholderbach 2024-07-25 21:41:23 +02:00
parent 928c57db41
commit 4ea08abbc2
3 changed files with 9 additions and 9 deletions

View File

@ -660,10 +660,10 @@ impl Path {
/// the current directory. /// the current directory.
/// ///
/// * On Unix, a path is absolute if it starts with the root, /// * On Unix, a path is absolute if it starts with the root,
/// so [`is_absolute`](Path::is_absolute) and [`has_root`](Path::has_root) are equivalent. /// so [`is_absolute`](Path::is_absolute) and [`has_root`](Path::has_root) are equivalent.
/// ///
/// * On Windows, a path is absolute if it has a prefix and starts with the root: /// * On Windows, a path is absolute if it has a prefix and starts with the root:
/// `c:\windows` is absolute, while `c:temp` and `\temp` are not. /// `c:\windows` is absolute, while `c:temp` and `\temp` are not.
/// ///
/// # Examples /// # Examples
/// ///

View File

@ -19,12 +19,12 @@ const LINE_ENDING_PATTERN: &[char] = &['\r', '\n'];
/// We've tried a few variations of this structure. Listing these below so we have a record. /// We've tried a few variations of this structure. Listing these below so we have a record.
/// ///
/// * We tried always assuming a stream in Nushell. This was a great 80% solution, but it had some rough edges. /// * We tried always assuming a stream in Nushell. This was a great 80% solution, but it had some rough edges.
/// Namely, how do you know the difference between a single string and a list of one string. How do you know /// Namely, how do you know the difference between a single string and a list of one string. How do you know
/// when to flatten the data given to you from a data source into the stream or to keep it as an unflattened /// when to flatten the data given to you from a data source into the stream or to keep it as an unflattened
/// list? /// list?
/// ///
/// * We tried putting the stream into Value. This had some interesting properties as now commands "just worked /// * We tried putting the stream into Value. This had some interesting properties as now commands "just worked
/// on values", but lead to a few unfortunate issues. /// on values", but lead to a few unfortunate issues.
/// ///
/// The first is that you can't easily clone Values in a way that felt largely immutable. For example, if /// The first is that you can't easily clone Values in a way that felt largely immutable. For example, if
/// you cloned a Value which contained a stream, and in one variable drained some part of it, then the second /// you cloned a Value which contained a stream, and in one variable drained some part of it, then the second
@ -37,8 +37,8 @@ const LINE_ENDING_PATTERN: &[char] = &['\r', '\n'];
/// concrete list values rather than streams, and be able to view them without non-local effects. /// concrete list values rather than streams, and be able to view them without non-local effects.
/// ///
/// * A balance of the two approaches is what we've landed on: Values are thread-safe to pass, and we can stream /// * A balance of the two approaches is what we've landed on: Values are thread-safe to pass, and we can stream
/// them into any sources. Streams are still available to model the infinite streams approach of original /// them into any sources. Streams are still available to model the infinite streams approach of original
/// Nushell. /// Nushell.
#[derive(Debug)] #[derive(Debug)]
pub enum PipelineData { pub enum PipelineData {
Empty, Empty,

View File

@ -12,7 +12,7 @@ use std::sync::Arc;
/// > **Note** /// > **Note**
/// > [`Span`] can be passed to [`from_nuon`] if there is context available to the caller, e.g. when /// > [`Span`] can be passed to [`from_nuon`] if there is context available to the caller, e.g. when
/// > using this function in a command implementation such as /// > using this function in a command implementation such as
/// [`from nuon`](https://www.nushell.sh/commands/docs/from_nuon.html). /// > [`from nuon`](https://www.nushell.sh/commands/docs/from_nuon.html).
/// ///
/// also see [`super::to_nuon`] for the inverse operation /// also see [`super::to_nuon`] for the inverse operation
pub fn from_nuon(input: &str, span: Option<Span>) -> Result<Value, ShellError> { pub fn from_nuon(input: &str, span: Option<Span>) -> Result<Value, ShellError> {