From e29bd6f2b74364e359db2c2d3266d82f9c30b620 Mon Sep 17 00:00:00 2001
From: Andrew Chen Wang <60190294+Andrew-Chen-Wang@users.noreply.github.com>
Date: Fri, 23 Dec 2022 19:50:35 -0500
Subject: [PATCH] Add docstring for populate_user

---
 .../{{cookiecutter.project_slug}}/users/adapters.py          | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py
index 516bccb8f..0b26a8c4a 100644
--- a/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py
+++ b/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/users/adapters.py
@@ -15,7 +15,10 @@ class SocialAccountAdapter(DefaultSocialAccountAdapter):
     def is_open_for_signup(self, request: HttpRequest, sociallogin: Any):
         return getattr(settings, "ACCOUNT_ALLOW_REGISTRATION", True)
 
-    def populate_user(self, request, sociallogin, data):
+        """
+        Populates user information from social provider info
+        See: https://django-allauth.readthedocs.io/en/latest/advanced.html?highlight=populate_user#creating-and-populating-user-instances
+        """
         user = sociallogin.user
         if name := data.get("name"):
             user.name = name