From: Gilead Baggio <gilsedition@gmail.com>
Date: Sun, 3 Oct 2021 09:46:58 +0000 (+0530)
Subject: Documentation: Added screen_name parameter to get_user method
X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=124e705ce2c5e60d7ecdfbf9761a3f7826024acf;p=tweepy.git

Documentation: Added screen_name parameter to get_user method

In Getting started section of the documentation, under Models sub-heading, its mentioned as:
user = api.get_user('twitter')
but it returns the error found below:
TypeError: get_user() takes 1 positional argument but 2 were given.

So it would be easier for dummies like me, if its mentioned as
user = api.get_user(screen_name='twitter')
instead.
---

diff --git a/docs/getting_started.rst b/docs/getting_started.rst
index 90214ce..229f8a4 100644
--- a/docs/getting_started.rst
+++ b/docs/getting_started.rst
@@ -50,7 +50,7 @@ from Twitter which we can then use inside our application. For example
 the following code returns to us a User model::
 
    # Get the User object for twitter...
-   user = api.get_user('twitter')
+   user = api.get_user(screen_name='twitter')
 
 Models contain the data and some helper methods which we can then
 use::