Fix docstrings

Author: codingjoe

mailauth/contrib/user/models.py

@@ -8,9 +8,7 @@ class EmailUserManager(BaseUserManager):
     use_in_migrations = True
 
     def _create_user(self, email, **extra_fields):
-        """
-        Create and save a user with the given username, email, and password.
-        """
+        """Create and save a user with the given email."""
         email = self.normalize_email(email)
         user = self.model(email=email, **extra_fields)
         user.save(using=self._db)

mailauth/forms.py

@@ -23,6 +23,7 @@ def get_login_url(self, request, token, next=None):
 
         Returns:
             str: User login URL including the access token.
+
         """
         protocol = 'https' if request.is_secure() else 'http'
         current_site = get_current_site(request)
@@ -74,7 +75,9 @@ def get_context(self, request, user):
 
     def save(self):
         """
-        Method will be called from the view, if the form is valid.
+        Send login URL to users.
+
+        Called from the login view, if the form is valid.
 
         This method must be implemented by subclasses. This method
         should trigger the login url to be sent to the user.
@@ -84,6 +87,7 @@ def save(self):
 
 class EmailLoginForm(BaseLoginForm):
     """Login form that contains only the Users email field."""
+
     subject_template_name = 'registration/login_subject.txt'
     email_template_name = 'registration/login_email.txt'
     html_email_template_name = 'registration/login_email.html'

mailauth/views.py

@@ -16,8 +16,9 @@
 
 class LoginView(DjangoLoginView):
     """
-    Sends a login code to the user.
-    It doesn't authenticate a user but it is the entry point for the login process (login url).
+    Send a login code to the user.
+
+    It doesn't authenticate a user but it is the entry point for the login process (login URL).
     """
 
     form_class = forms.EmailLoginForm

tests/conftest.py

@@ -14,7 +14,7 @@ def timestamp(self):
 
 @pytest.fixture()
 def user(db):
-    """A user instance."""
+    """Return a user instance."""
     return get_user_model().objects.create_user(
         pk=1337,
         email='spiderman@avengers.com',
@@ -24,7 +24,7 @@ def user(db):
 
 @pytest.fixture()
 def admin_user(db):
-    """A user instance."""
+    """Return a user instance."""
     return get_user_model().objects.create_user(
         pk=1337,
         email='spiderman@avengers.com',
@@ -35,11 +35,11 @@ def admin_user(db):
 
 @pytest.fixture()
 def signature():
-    """A signature matching the user fixture."""
+    """Return a signature matching the user fixture."""
     return 'LZ/173QUS/1Hjptg/fTLJcaon_7zMDyFTIFtlDqbdSt4'
 
 
 @pytest.fixture()
 def signer():
-    """A forzen version of the UserSigner."""
+    """Return a forzen version of the UserSigner."""
     return FrozenUserSigner(sep='/')

tests/testapp/urls.py

@@ -1,18 +1,3 @@
-"""testapp URL Configuration
-
-The `urlpatterns` list routes URLs to views. For more information please see:
-    https://docs.djangoproject.com/en/2.2/topics/http/urls/
-Examples:
-Function views
-    1. Add an import:  from my_app import views
-    2. Add a URL to urlpatterns:  path('', views.home, name='home')
-Class-based views
-    1. Add an import:  from other_app.views import Home
-    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
-Including another URLconf
-    1. Import the include() function: from django.urls import include, path
-    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
-"""
 from django.contrib import admin
 from django.urls import include, path