From 92c775090205301afaba6e38af3e5fe7982e6096 Mon Sep 17 00:00:00 2001 From: Steve Moyer Date: Mon, 5 Jan 2026 08:58:11 -0500 Subject: [PATCH] docs(crypto): tweak package docs format --- crypto/public.go | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/crypto/public.go b/crypto/public.go index 652f47f..d9a88bb 100644 --- a/crypto/public.go +++ b/crypto/public.go @@ -1,11 +1,11 @@ -// This crypto package is a thin ergonomic layer on top of the normal golang crypto packages or `x/crypto`. +// Package crypto is a thin ergonomic layer on top of the normal golang crypto packages or `x/crypto`. // // It aims to solve the following problems with the standard crypto packages: -// - different algorithms have different APIs and ergonomics, which makes it hard to use them interchangeably -// - occasionally, it's quite hard to figure out how to do simple tasks (like encoding/decoding keys) -// - it's still necessary to make some educated choices (e.g. which hash function to use for signatures) -// - sometimes features are left out (e.g. ed25519 to X25519 for key exchange, secp256k1...) -// - some hash functions are not available in the standard library with no easy way to extend it (e.g. KECCAK-256) +// - different algorithms have different APIs and ergonomics, which makes it hard to use them interchangeably +// - occasionally, it's quite hard to figure out how to do simple tasks (like encoding/decoding keys) +// - it's still necessary to make some educated choices (e.g. which hash function to use for signatures) +// - sometimes features are left out (e.g. ed25519 to X25519 for key exchange, secp256k1...) +// - some hash functions are not available in the standard library with no easy way to extend it (e.g. KECCAK-256) // // To do so, this package provides and implements a set of shared interfaces for all algorithms. As not all algorithms // support all features (e.g. RSA keys don't support key exchange), some interfaces are optionally implemented.