Tweak documentation (#1018)

lestrrat-go · Nov 20, 2023 · 9156743 · 9156743
1 parent ee031a0
commit 9156743
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/Changes b/Changes
@@ -4,10 +4,10 @@ Changes
 v2 has many incompatibilities with v1. To see the full list of differences between
 v1 and v2, please read the Changes-v2.md file (https://github.com/lestrrat-go/jwx/blob/develop/v2/Changes-v2.md)
 
-v2.0.17 UNRELEASED
+v2.0.17 20 Nov 2023
 [Bug Fixes]
   * [jws] Previously, `jws.UnregisterSigner` did not remove the previous signer instance when
-    the signer was registered and unregistered multiple times. This has been fixed.
+    the signer was registered and unregistered multiple times (#1016). This has been fixed.
 
 [New Features]
   * [jwe] (EXPERIMENTAL) `jwe.WithCEK` has been added to extract the content encryption key (CEK) from the Decrypt operation.

diff --git a/jws/signer.go b/jws/signer.go
@@ -20,7 +20,8 @@ var muSignerDB sync.RWMutex
 var signerDB map[jwa.SignatureAlgorithm]SignerFactory
 
 // RegisterSigner is used to register a factory object that creates
-// Signer objects based on the given algorithm.
+// Signer objects based on the given algorithm. Previous object instantiated
+// by the factory is discarded.
 //
 // For example, if you would like to provide a custom signer for
 // jwa.EdDSA, use this function to register a `SignerFactory`
@@ -40,7 +41,8 @@ func RegisterSigner(alg jwa.SignatureAlgorithm, f SignerFactory) {
 }
 
 // UnregisterSigner removes the signer factory associated with
-// the given algorithm.
+// the given algorithm, as well as the signer instance created
+// by the factory.
 //
 // Note that when you call this function, the algorithm itself is
 // not automatically unregistered from the known algorithms database.