Fix Sphinx warning and improve docstrings

codingjoe · codingjoe · commit aec86b281a23 · 2022-02-25T11:03:58.000+01:00
diff --git a/docs/customizing.rst b/docs/customizing.rst
@@ -118,7 +118,9 @@ API documentation
     :members:
 
     .. autoattribute:: mailauth.contrib.user.models.AbstractEmailUser.email
+       :noindex:
     .. autoattribute:: mailauth.contrib.user.models.AbstractEmailUser.session_salt
+       :noindex:
 
 .. autoclass:: mailauth.contrib.user.models.EmailUser
     :members:
diff --git a/mailauth/contrib/user/models.py b/mailauth/contrib/user/models.py
@@ -51,14 +51,14 @@ class AbstractEmailUser(AbstractUser):
     password = None
 
     email = CIEmailField(_("email address"), unique=True, db_index=True)
-    """The field is unique and case insensitive to serve as a better username."""
+    """Unique and case insensitive to serve as a better username."""
 
-    # Salt for the session hash replacing the password in this function.
     session_salt = models.CharField(
         max_length=12,
         editable=False,
         default=_get_session_salt,
     )
+    """Salt for the session hash replacing the password in this function."""
 
     def has_usable_password(self):
         return False
