Skip to content

docs(data-structures): enable lint warnings on missing docs, and add missing doc comments #6612

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
graphite-app merged 1 commit into from
Oct 15, 2024
Merged

docs(data-structures): enable lint warnings on missing docs, and add missing doc comments #6612

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
docs(data-structures): enable lint warnings on missing docs, and add … 
…missing doc comments (#6612)

Part of oxc-project/backlog#130
  • Loading branch information
@DonIsaac
DonIsaac committed Oct 15, 2024
commit de22b81b83ab500ac2f7b21652e1612ff4c10279
2 changes: 2 additions & 0 deletions crates/oxc_data_structures/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
//! Data structures used across other oxc crates.
#![warn(missing_docs)]
pub mod stack;
5 changes: 5 additions & 0 deletions crates/oxc_data_structures/src/stack/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down
1 change: 0 additions & 1 deletion crates/oxc_span/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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;
Expand Down