Skip to content

Commit c8573f4

Browse files
committed
Incorporate README.md into rustdoc where it wasn't already
The `cipher`, `crypto-common`, and `digest` crates didn't yet do this
1 parent d9067c4 commit c8573f4

File tree

6 files changed

+18
-25
lines changed

6 files changed

+18
-25
lines changed

Cargo.toml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ cast_possible_wrap = "warn"
2222
cast_precision_loss = "warn"
2323
cast_sign_loss = "warn"
2424
checked_conversions = "warn"
25-
doc_markdown = "warn"
2625
from_iter_instead_of_collect = "warn"
2726
implicit_saturating_sub = "warn"
2827
manual_assert = "warn"

cipher/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
[![Project Chat][chat-image]][chat-link]
88
[![Build Status][build-image]][build-link]
99

10-
Traits which define the functionality of [block ciphers] and [stream ciphers].
10+
Traits which define the functionality of [block ciphers], [block modes] and
11+
[stream ciphers].
1112

1213
See [RustCrypto/block-ciphers] and [RustCrypto/stream-ciphers] for algorithm
1314
implementations which use these traits.
@@ -48,6 +49,7 @@ dual licensed as above, without any additional terms or conditions.
4849
[//]: # (general links)
4950

5051
[block ciphers]: https://en.wikipedia.org/wiki/Block_cipher
52+
[block modes]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
5153
[stream ciphers]: https://en.wikipedia.org/wiki/Stream_cipher
5254
[RustCrypto/block-ciphers]: https://github.com/RustCrypto/block-ciphers
5355
[RustCrypto/stream-ciphers]: https://github.com/RustCrypto/stream-ciphers

cipher/src/lib.rs

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
1-
//! This crate defines a set of traits which describe the functionality of
2-
//! [block ciphers][1], [block modes][2], and [stream ciphers][3].
3-
//!
4-
//! [1]: https://en.wikipedia.org/wiki/Block_cipher
5-
//! [2]: https://en.wikipedia.org/wiki/Block_cipher_mode_of_operation
6-
//! [3]: https://en.wikipedia.org/wiki/Stream_cipher
7-
81
#![no_std]
92
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
104
#![doc(
115
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
126
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"

crypto-common/src/lib.rs

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
1-
//! Common cryptographic traits.
2-
31
#![no_std]
42
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
54
#![doc(
65
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
76
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
87
)]
98
#![forbid(unsafe_code)]
10-
#![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)]
119

1210
/// Hazardous materials.
1311
pub mod hazmat;

digest/src/lib.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,16 @@
1-
//! This crate provides traits which describe functionality of cryptographic hash
2-
//! functions and Message Authentication algorithms.
1+
#![no_std]
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
3+
#![doc = include_str!("../README.md")]
4+
#![forbid(unsafe_code)]
5+
#![doc(
6+
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
7+
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
8+
)]
9+
#![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)]
10+
11+
//! ## Structure
312
//!
4-
//! Traits in this repository are organized into the following levels:
13+
//! Traits in this crate are organized into the following levels:
514
//!
615
//! - **High-level convenience traits**: [`Digest`], [`DynDigest`], [`Mac`].
716
//! Wrappers around lower-level traits for most common use-cases. Users should
@@ -24,15 +33,6 @@
2433
//!
2534
//! [`digest-io`]: https://docs.rs/digest-io
2635
27-
#![no_std]
28-
#![cfg_attr(docsrs, feature(doc_cfg))]
29-
#![forbid(unsafe_code)]
30-
#![doc(
31-
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg",
32-
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/6ee8e381/logo.svg"
33-
)]
34-
#![warn(missing_docs, rust_2018_idioms, missing_debug_implementations)]
35-
3636
#[cfg(feature = "alloc")]
3737
#[macro_use]
3838
extern crate alloc;

signature/src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
#![no_std]
2+
#![cfg_attr(docsrs, feature(doc_cfg))]
23
#![doc = include_str!("../README.md")]
34
#![doc(
45
html_logo_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg",
56
html_favicon_url = "https://raw.githubusercontent.com/RustCrypto/media/8f1a9894/logo.svg"
67
)]
7-
#![cfg_attr(docsrs, feature(doc_cfg))]
88
#![forbid(unsafe_code)]
99
#![allow(async_fn_in_trait)]
1010
#![warn(

0 commit comments

Comments
 (0)