extern/nushell
1
0
Fork 1
mirror of https://github.com/nushell/nushell.git synced 2025-08-09 12:25:58 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add top-level crate documentation/READMEs (#12907)

Browse Source 
# Description
Add `README.md` files to each crate in our workspace (-plugins) and also
include it in the `lib.rs` documentation for <docs.rs> (if there is no
existing `lib.rs` crate documentation)

In all new README I added the defensive comment that the crates are not
considered stable for public consumption. If necessary we can adjust
this if we deem a crate useful for plugin authors.
This commit is contained in:
Stefan Holderbach
2024-07-14 10:10:41 +02:00
committed by GitHub
parent f5bff8c9c8
commit c5aa15c7f6
36 changed files with 109 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
crates/nu-protocol/src/lib.rs
View File

@ -1,3 +1,4 @@
#![doc = include_str!("../README.md")]
mod alias;
pub mod ast;
pub mod config;

4
crates/nu-protocol/src/pipeline/byte_stream.rs
View File

@ -159,14 +159,14 @@ impl From<ByteStreamType> for Type {
/// Try not to use this method if possible. Rather, please use [`reader`](ByteStream::reader)
/// (or [`lines`](ByteStream::lines) if it matches the situation).
///
/// Additionally, there are few methods to collect a [`Bytestream`] into memory:
/// Additionally, there are few methods to collect a [`ByteStream`] into memory:
/// - [`into_bytes`](ByteStream::into_bytes): collects all bytes into a [`Vec<u8>`].
/// - [`into_string`](ByteStream::into_string): collects all bytes into a [`String`], erroring if utf-8 decoding failed.
/// - [`into_value`](ByteStream::into_value): collects all bytes into a value typed appropriately
/// for the [type](.type_()) of this stream. If the type is [`Unknown`](ByteStreamType::Unknown),
/// it will produce a string value if the data is valid UTF-8, or a binary value otherwise.
///
/// There are also a few other methods to consume all the data of a [`Bytestream`]:
/// There are also a few other methods to consume all the data of a [`ByteStream`]:
/// - [`drain`](ByteStream::drain): consumes all bytes and outputs nothing.
/// - [`write_to`](ByteStream::write_to): writes all bytes to the given [`Write`] destination.
/// - [`print`](ByteStream::print): a convenience wrapper around [`write_to`](ByteStream::write_to).