Doc-comment public nu-protocol modules

crates/nu-protocol/src/ast/mod.rs

@@ -1,3 +1,4 @@
+//! Types representing parsed Nushell code (the Abstract Syntax Tree)
 mod block;
 mod call;
 mod cell_path;
@@ -9,7 +10,7 @@ mod match_pattern;
 mod operator;
 mod pipeline;
 mod range;
-pub mod table;
+mod table;
 mod unit;
 mod value_with_unit;
 

crates/nu-protocol/src/config/mod.rs

@@ -1,3 +1,4 @@
+//! Module containing the internal representation of user configuration
 use self::completer::*;
 use self::helper::*;
 use self::hooks::*;

crates/nu-protocol/src/debugger/mod.rs

@@ -1,3 +1,4 @@
+//! Module containing the trait to instrument the engine for debugging and profiling
 pub mod debugger_trait;
 pub mod profiler;
 

crates/nu-protocol/src/engine/mod.rs

@@ -1,3 +1,4 @@
+//! Representation of the engine state and many of the details that implement the scoping
 mod cached_file;
 mod call_info;
 mod capture_block;

crates/nu-protocol/src/errors/cli_error.rs

@@ -1,3 +1,6 @@
+//! This module manages the step of turning error types into printed error messages
+//!
+//! Relies on the `miette` crate for pretty layout
 use crate::{
     engine::{EngineState, StateWorkingSet},
     ErrorStyle,

crates/nu-protocol/src/eval_base.rs

@@ -1,3 +1,4 @@
+//! Foundational [`Eval`] trait allowing dispatch between const-eval and regular evaluation
 use crate::{
     ast::{
         eval_operator, Assignment, Bits, Boolean, Call, Comparison, Expr, Expression,

crates/nu-protocol/src/eval_const.rs

@@ -1,3 +1,7 @@
+//! Implementation of const-evaluation
+//!
+//! This enables you to assign `const`-constants and execute parse-time code dependent on this.
+//! e.g. `source $my_const`
 use crate::{
     ast::{Assignment, Block, Call, Expr, Expression, ExternalArgument},
     debugger::{DebugContext, WithoutDebug},

crates/nu-protocol/src/pipeline/byte_stream.rs

@@ -1,3 +1,4 @@
+//! Module managing the streaming of raw bytes between pipeline elements
 use crate::{
     process::{ChildPipe, ChildProcess, ExitStatus},
     ErrSpan, IntoSpanned, OutDest, PipelineData, ShellError, Span, Value,

crates/nu-protocol/src/pipeline/list_stream.rs

@@ -1,3 +1,7 @@
+//! Module managing the streaming of individual [`Value`]s as a [`ListStream`] between pipeline
+//! elements
+//!
+//! For more general infos regarding our pipelining model refer to [`PipelineData`]
 use crate::{Config, PipelineData, ShellError, Span, Value};
 use std::{
     fmt::Debug,

crates/nu-protocol/src/process/mod.rs

@@ -1,3 +1,4 @@
+//! Handling of external subprocesses
 mod child;
 mod exit_status;
 

crates/nu-protocol/src/span.rs

@@ -1,3 +1,4 @@
+//! [`Span`] to point to sections of source code and the [`Spanned`] wrapper type
 use miette::SourceSpan;
 use serde::{Deserialize, Serialize};
 use std::ops::Deref;

crates/nu-protocol/src/value/record.rs

@@ -1,3 +1,4 @@
+//! Our insertion ordered map-type [`Record`]
 use std::{iter::FusedIterator, ops::RangeBounds};
 
 use crate::{ShellError, Span, Value};