docs(data-structures): enable lint warnings on missing docs, and add …

…missing doc comments (#6612) Part of oxc-project/backlog#130
oxc-project · Oct 15, 2024 · de22b81 · de22b81
1 parent 335b7f2
commit de22b81
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/crates/oxc_data_structures/src/lib.rs b/crates/oxc_data_structures/src/lib.rs
@@ -1 +1,3 @@
+//! Data structures used across other oxc crates.
+#![warn(missing_docs)]
 pub mod stack;
diff --git a/crates/oxc_data_structures/src/stack/mod.rs b/crates/oxc_data_structures/src/stack/mod.rs
@@ -1,3 +1,8 @@
+//! Contains the following FILO data structures:
+//! - [`Stack`]: A growable stack
+//! - [`SparseStack`]: A stack that can have empty entries
+//! - [`NonEmptyStack`]: A growable stack that can never be empty, allowing for more efficient
+//!  operations
 mod capacity;
 mod common;
 mod non_empty;

diff --git a/crates/oxc_span/src/lib.rs b/crates/oxc_span/src/lib.rs
@@ -1,7 +1,6 @@
 //! Source positions and related helper functions.
 //!
 //! <https://doc.rust-lang.org/beta/nightly-rustc/rustc_span>
-#![warn(missing_docs)]
 
 mod atom;
 mod compact_str;