Skip to content

Commit d96982d

Browse files
authored
Fix a few markdown issues in docs (#446)
1 parent fbcfd39 commit d96982d

File tree

3 files changed

+10
-3
lines changed

3 files changed

+10
-3
lines changed

src/crypto/mod.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
//! The cryptography of the `jsonwebtoken` crate is decoupled behind
22
//! [`JwtSigner`] and [`JwtVerifier`] traits. These make use of `RustCrypto`'s
33
//! [`Signer`] and [`Verifier`] traits respectively.
4+
//!
5+
//! [`JwtSigner`]: crate::crypto::JwtSigner
6+
//! [`JwtVerifier`]: crate::crypto::JwtVerifier
7+
//! [`Signer`]: signature::Signer
8+
//! [`Verifier`]: signature::Verifier
49
510
use crate::algorithms::Algorithm;
611
use crate::errors::Result;

src/jwk.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#![allow(missing_docs)]
22
//! This crate contains types only for working JWK and JWK Sets
33
//! This is only meant to be used to deal with public JWK, not generate ones.
4-
//! Most of the code in this file is taken from https://github.com/lawliet89/biscuit but
4+
//! Most of the code in this file is taken from <https://github.com/lawliet89/biscuit> but
55
//! tweaked to remove the private bits as it's not the goal for this crate currently.
66
77
use std::{fmt, str::FromStr};
@@ -596,7 +596,7 @@ impl Jwk {
596596

597597
/// Compute the thumbprint of the JWK.
598598
///
599-
/// Per (RFC-7638)[https://datatracker.ietf.org/doc/html/rfc7638]
599+
/// Per [RFC-7638](https://datatracker.ietf.org/doc/html/rfc7638)
600600
pub fn thumbprint(&self, hash_function: ThumbprintHash) -> String {
601601
let pre = match &self.algorithm {
602602
AlgorithmParameters::EllipticCurve(a) => match a.curve {

src/lib.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
//! Create and parses JWT (JSON Web Tokens)
22
//!
3-
//! Documentation: [stable](https://docs.rs/jsonwebtoken/)
3+
//! Documentation: [stable](https://docs.rs/jsonwebtoken)
4+
//!
5+
46
#![deny(missing_docs)]
57

68
#[cfg(all(feature = "rust_crypto", feature = "aws_lc_rs"))]

0 commit comments

Comments
 (0)