docs: add comment for email preferences over phone

supabase-community · Nov 4, 2021 · e900c49 · e900c49
1 parent c2d37fb
commit e900c49
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/gotrue/_async/client.py b/gotrue/_async/client.py
@@ -92,7 +92,8 @@ async def sign_up(
         redirect_to: Optional[str] = None,
         data: Optional[dict[str, Any]] = None,
     ) -> Union[Session, User]:
-        """Creates a new user.
+        """Creates a new user. If email and phone are provided, email will be
+        used and phone will be ignored.
 
         Parameters
         ---------
@@ -155,6 +156,7 @@ async def sign_in(
         scopes: Optional[str] = None,
     ) -> Optional[Union[Session, str]]:
         """Log in an existing user, or login via a third-party provider.
+        If email and phone are provided, email will be used and phone will be ignored.
 
         Parameters
         ---------

diff --git a/gotrue/_sync/client.py b/gotrue/_sync/client.py
@@ -92,7 +92,8 @@ def sign_up(
         redirect_to: Optional[str] = None,
         data: Optional[dict[str, Any]] = None,
     ) -> Union[Session, User]:
-        """Creates a new user.
+        """Creates a new user. If email and phone are provided, email will be
+        used and phone will be ignored.
 
         Parameters
         ---------
@@ -155,6 +156,7 @@ def sign_in(
         scopes: Optional[str] = None,
     ) -> Optional[Union[Session, str]]:
         """Log in an existing user, or login via a third-party provider.
+        If email and phone are provided, email will be used and phone will be ignored.
 
         Parameters
         ---------