Skip to content
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.

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

docs: clean up #259

Merged
merged 1 commit into from
Jan 20, 2025
Merged
Changes from all commits
Commits
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
2 changes: 0 additions & 2 deletions crates/aac/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-aac
//!
//! A crate for decoding AAC audio headers.
//!
//! ## License
4 changes: 0 additions & 4 deletions crates/av1/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
//! # scuffle-av1
//!
//! [![crates.io](https://img.shields.io/crates/v/scuffle-av1.svg)](https://crates.io/crates/scuffle-av1) [![docs.rs](https://img.shields.io/docsrs/scuffle-av1)](https://docs.rs/scuffle-av1)
//!
//! A crate for decoding and encoding AV1 video headers.
//!
//! ## License
2 changes: 0 additions & 2 deletions crates/batching/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-batching
//!
//! A crate designed to batch multiple requests into a single request.
//!
//! ## Why do we need this?
2 changes: 0 additions & 2 deletions crates/bootstrap/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-bootstrap
//!
//! A utility crate for creating binaries.
//!
//! Refer to [`Global`], [`Service`], and [`main`] for more information.
2 changes: 0 additions & 2 deletions crates/bootstrap/telemetry/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-bootstrap-telemetry
//!
//! A crate used to add telemetry to applications built with the
//! [`scuffle-bootstrap`](../scuffle_bootstrap) crate.
//!
2 changes: 0 additions & 2 deletions crates/context/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-context
//!
//! A crate designed to provide the ability to cancel futures using a context
//! go-like approach, allowing for graceful shutdowns and cancellations.
//!
2 changes: 0 additions & 2 deletions crates/expgolomb/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-expgolomb
//!
//! A set of helper functions to encode and decode exponential-golomb values.
//!
//! This crate extends upon the [`BitReader`] and [`BitWriter`] from the
2 changes: 0 additions & 2 deletions crates/flv/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-flv
//!
//! A pure Rust implementation of the FLV format, allowing for demuxing of FLV
//! files or streams.
//!
2 changes: 0 additions & 2 deletions crates/metrics/derive/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-metrics-derive
//!
//! A proc-macro to derive the `#[metrics]` attribute and the
//! `#[derive(MetricEnum)]` attribute.
//!
2 changes: 0 additions & 2 deletions crates/metrics/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-metrics
//!
//! A wrapper around opentelemetry to provide a more ergonomic interface for
//! creating metrics.
//!
2 changes: 0 additions & 2 deletions crates/signal/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
//! # scuffle-signal
//!
//! A crate designed to provide a more user friendly interface to
//! `tokio::signal`.
//!