docs: Move crate documentation to top of lib.rs

pull/24376/head
Carol (Nichols || Goulding) 2021-10-25 15:58:59 -04:00 committed by Carol (Nichols || Goulding)
parent eeb017990d
commit 80f04e8fec
No known key found for this signature in database
GPG Key ID: E907EE5A736F87D4
1 changed files with 5 additions and 5 deletions

View File

@ -1,3 +1,8 @@
//! Wraps the object_store crate with IOx-specific semantics. The main responsibility of this crate
//! is to be the single source of truth for the paths of files in object storage. There is a
//! specific path type for each IOx-specific reason an object storage file exists. Content of the
//! files is managed outside of this crate.
#![deny(rustdoc::broken_intra_doc_links, rustdoc::bare_urls, rust_2018_idioms)]
#![warn(
missing_copy_implementations,
@ -9,11 +14,6 @@
clippy::clone_on_ref_ptr
)]
//! Wraps the object_store crate with IOx-specific semantics. The main responsibility of this crate
//! is to be the single source of truth for the paths of files in object storage. There is a
//! specific path type for each IOx-specific reason an object storage file exists. Content of the
//! files is managed outside of this crate.
use bytes::{Bytes, BytesMut};
use chrono::{DateTime, Utc};
use data_types::{