Skip to content

ed25519: add (doctested!) ed25519-dalek usage example#167

Merged
tarcieri merged 1 commit intomasterfrom
ed25519/dalek-example
Sep 11, 2020
Merged

ed25519: add (doctested!) ed25519-dalek usage example#167
tarcieri merged 1 commit intomasterfrom
ed25519/dalek-example

Conversation

@tarcieri
Copy link
Copy Markdown
Member

Adds a rustdoc example which completely demonstrates how to use code written generically with ed25519::Signature and signature::{Signer, Verifier} with the concrete ed25519_dalek::{Keypair, PublicKey} types.

Unlike the previous example, which hardly showed anything, this commit also pulls in ed25519-dalek as a [dev-dependency], which makes it possible to actually doctest the example.

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Sep 11, 2020

Codecov Report

Merging #167 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #167   +/-   ##
=======================================
  Coverage   49.54%   49.54%           
=======================================
  Files           7        7           
  Lines         436      436           
=======================================
  Hits          216      216           
  Misses        220      220           
Impacted Files Coverage Δ
ed25519/src/lib.rs 65.30% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 886a9d4...53dbfe3. Read the comment docs.

@tarcieri tarcieri force-pushed the ed25519/dalek-example branch 2 times, most recently from 4af8e8f to 98cbd96 Compare September 11, 2020 21:56
Adds a rustdoc example which completely demonstrates how to use code
written generically with `ed25519::Signature` and `signature::{Signer,
Verifier}` with the concrete `ed25519_dalek::{Keypair, PublicKey}`
types.

Unlike the previous example, which hardly showed anything, this commit
also pulls in `ed25519-dalek` as a `[dev-dependency]`, which makes it
possible to actually doctest the example.
@tarcieri tarcieri force-pushed the ed25519/dalek-example branch from 98cbd96 to 53dbfe3 Compare September 11, 2020 22:08
@tarcieri tarcieri merged commit 7fa56f9 into master Sep 11, 2020
@tarcieri tarcieri deleted the ed25519/dalek-example branch September 11, 2020 22:20
@tarcieri tarcieri mentioned this pull request Sep 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants