docs: update jwt docs, update api docstring

Author: lepture

docs/guide/jwt.rst

@@ -290,7 +290,7 @@ Algorithms & Registry
 ---------------------
 
 The :meth:`encode` and :meth:`decode` accept an ``algorithms`` parameter for
-specifying the allowed algorithms. By default, it only allows your to use
+specifying the allowed algorithms. By default, it only allows you to use the
 **recommended** algorithms.
 
 You can find out the recommended algorithms at:
@@ -320,7 +320,7 @@ JSON Encoder and Decoder
     The parameters ``encoder_cls`` for ``jwt.encode`` and ``decoder_cls`` for ``jwt.decode``
     were introduced in version 1.1.0.
 
-When using ``jwt.encode``` to encode claims that contain data types that ``json``
+When using ``jwt.encode`` to encode claims that contain data types that ``json``
 module does not natively support, such as ``UUID`` and ``datetime``, an error will
 be raised.
 

src/joserfc/rfc7515/model.py

@@ -37,11 +37,14 @@ class CompactSignature:
     """
 
     def __init__(self, protected: Header, payload: bytes):
+        #: protected header
         self.protected = protected
+        #: payload content in bytes
         self.payload = payload
         self.segments: SegmentsDict = {}
 
     def headers(self) -> Header:
+        """Returns protected header values in dict."""
         return self.protected
 
     def set_kid(self, kid: str) -> None:
@@ -56,17 +59,20 @@ class FlattenedJSONSignature:
 
     def __init__(self, member: HeaderMember, payload: bytes):
         #: the only header member
-        self.member = member
-        #: payload content
-        self.payload = payload
+        self.member: HeaderMember = member
+        #: payload content in bytes
+        self.payload: bytes = payload
         self.signature: JSONSignatureDict | None = None
         self.segments: SegmentsDict = {}
 
     @property
     def members(self) -> list[HeaderMember]:
+        """A list of header members. For flattened JSON serialization, there will
+        be only one header member."""
         return [self.member]
 
     def headers(self) -> Header:
+        """Header values in dict."""
         return self.member.headers()
 
 
@@ -78,9 +84,9 @@ class GeneralJSONSignature:
 
     def __init__(self, members: list[HeaderMember], payload: bytes):
         #: a list of header members
-        self.members = members
-        #: payload content
-        self.payload = payload
+        self.members: list[HeaderMember] = members
+        #: payload content in bytes
+        self.payload: bytes = payload
         self.signatures: list[JSONSignatureDict] = []
         self.segments: SegmentsDict = {}
 

src/joserfc/rfc7516/models.py

@@ -59,6 +59,7 @@ def __init__(self, protected: Header, plaintext: bytes | None = None):
         self.base64_segments: t.Dict[str, bytes] = {}  # store the encoded segments
 
     def headers(self) -> Header:
+        """Returns the protected header values in dict."""
         return self.protected
 
     def attach_recipient(self, key: Key, header: Header | None = None) -> None: