From 1b93fc0eb30507bc0a9b485dde278b7064b6f5b3 Mon Sep 17 00:00:00 2001 From: sholderbach Date: Sun, 19 May 2024 22:35:52 +0200 Subject: [PATCH] README rest --- crates/nu-cmd-base/README.md | 2 ++ crates/nu-color-config/README.md | 2 ++ crates/nu-command/README.md | 4 ++++ crates/nu-engine/README.md | 6 ++++++ crates/nu-explore/README.md | 2 ++ crates/nu-term-grid/README.md | 2 ++ crates/nu-test-support/README.md | 4 ++++ 7 files changed, 22 insertions(+) diff --git a/crates/nu-cmd-base/README.md b/crates/nu-cmd-base/README.md index 045a47a101..28d299928a 100644 --- a/crates/nu-cmd-base/README.md +++ b/crates/nu-cmd-base/README.md @@ -1,3 +1,5 @@ +Utilities used by the different `nu-command`/`nu-cmd-*` crates, should not contain any full `Command` implementations. + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly. diff --git a/crates/nu-color-config/README.md b/crates/nu-color-config/README.md index 045a47a101..f03753685c 100644 --- a/crates/nu-color-config/README.md +++ b/crates/nu-color-config/README.md @@ -1,3 +1,5 @@ +Logic to resolve colors for syntax highlighting and output formatting + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly. diff --git a/crates/nu-command/README.md b/crates/nu-command/README.md index 045a47a101..1cbb8cd9f2 100644 --- a/crates/nu-command/README.md +++ b/crates/nu-command/README.md @@ -1,3 +1,7 @@ +This crate contains the majority of our commands + +We allow ourselves to move some of the commands in `nu-command` to `nu-cmd-*` crates as needed. + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly. diff --git a/crates/nu-engine/README.md b/crates/nu-engine/README.md index 045a47a101..d5198cfc3f 100644 --- a/crates/nu-engine/README.md +++ b/crates/nu-engine/README.md @@ -1,3 +1,9 @@ +This crate primarily drives the evaluation of expressions. + +(Some overlap with nu-protocol) + +- Provides `CallExt` + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly. diff --git a/crates/nu-explore/README.md b/crates/nu-explore/README.md index 045a47a101..d18a576c43 100644 --- a/crates/nu-explore/README.md +++ b/crates/nu-explore/README.md @@ -1,3 +1,5 @@ +Implementation of the interactive `explore` command pager. + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly. diff --git a/crates/nu-term-grid/README.md b/crates/nu-term-grid/README.md index 045a47a101..5bdd32077d 100644 --- a/crates/nu-term-grid/README.md +++ b/crates/nu-term-grid/README.md @@ -1,3 +1,5 @@ +Implementation of the layout engine for the `grid` command. + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly. diff --git a/crates/nu-test-support/README.md b/crates/nu-test-support/README.md index 045a47a101..f384b15067 100644 --- a/crates/nu-test-support/README.md +++ b/crates/nu-test-support/README.md @@ -1,3 +1,7 @@ +This crate provides utilities for testing of Nushell + +Plugin authors should instead refer to `nu-plugin-test-support` + ## Internal Nushell crate This crate implements components of Nushell and is not designed to support plugin authors or other users directly.