From dd2fbb34018063b8d605ca9317b1f74243d22060 Mon Sep 17 00:00:00 2001 From: Jack Grigg Date: Tue, 24 Sep 2019 10:54:15 +0100 Subject: [PATCH] Crate docs --- src/bls12_381/mod.rs | 3 +++ src/lib.rs | 2 ++ 2 files changed, 5 insertions(+) diff --git a/src/bls12_381/mod.rs b/src/bls12_381/mod.rs index 8fc6bbdfd..e6e88ddba 100644 --- a/src/bls12_381/mod.rs +++ b/src/bls12_381/mod.rs @@ -1,3 +1,6 @@ +//! An implementation of the BLS12-381 pairing-friendly elliptic curve +//! construction. + mod ec; mod fq; mod fq12; diff --git a/src/lib.rs b/src/lib.rs index 9f20a8808..89e587373 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,5 @@ +//! A library for working with pairing-friendly curves. + // `clippy` is a code linting tool for improving code quality by catching // common mistakes or strange code patterns. If the `cargo-clippy` feature // is provided, all compiler warnings are prohibited.