From b4b94d05c5f70da4796db273df43ced2d40d6860 Mon Sep 17 00:00:00 2001 From: Tim Gates Date: Sun, 31 Jul 2022 09:24:22 +1000 Subject: [PATCH] docs: Fix a few typos There are small typos in: - docs/usage/advanced_usage.rst - docs/usage/basic_usage.rst - docs/usage/special_functions.rst - docs/usage/starting_out.rst - tests/test_endpoints.py - twython/endpoints.py - twython/streaming/api.py Fixes: - Should read `received` rather than `recieved`. - Should read `paginated` rather than `pagintated`. - Should read `multiple` rather than `mutiple`. - Should read `membership` rather than `memberhips`. - Should read `manipulate` rather than `maninpulate`. - Should read `explicitly` rather than `explicity`. - Should read `destroy` rather than `destory`. - Should read `authentication` rather than `autentication`. - Should read `actual` rather than `acutal`. Signed-off-by: Tim Gates --- docs/usage/advanced_usage.rst | 2 +- docs/usage/basic_usage.rst | 2 +- docs/usage/special_functions.rst | 4 ++-- docs/usage/starting_out.rst | 2 +- tests/test_endpoints.py | 4 ++-- twython/endpoints.py | 2 +- twython/streaming/api.py | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/usage/advanced_usage.rst b/docs/usage/advanced_usage.rst index df3bc485..4829ef32 100644 --- a/docs/usage/advanced_usage.rst +++ b/docs/usage/advanced_usage.rst @@ -104,7 +104,7 @@ Manipulate the Request (headers, proxies, etc.) There are times when you may want to turn SSL verification off, send custom headers, or add proxies for the request to go through. -Twython uses the `requests `_ library to make API calls to Twitter. ``requests`` accepts a few parameters to allow developers to manipulate the acutal HTTP request. +Twython uses the `requests `_ library to make API calls to Twitter. ``requests`` accepts a few parameters to allow developers to manipulate the actual HTTP request. Here is an example of sending custom headers to a Twitter API request: diff --git a/docs/usage/basic_usage.rst b/docs/usage/basic_usage.rst index 8fee8078..5f484fb2 100644 --- a/docs/usage/basic_usage.rst +++ b/docs/usage/basic_usage.rst @@ -80,7 +80,7 @@ Documentation: https://developer.twitter.com/en/docs/tweets/search/api-reference .. _dynamicargexplaination: -.. important:: To help explain :ref:`dynamic function arguments ` a little more, you can see that the previous call used the keyword argument ``q``, that is because Twitter specifies in their `search documentation `_ that the search call accepts the parameter "q". You can pass mutiple keyword arguments. The search documentation also specifies that the call accepts the parameter "result_type" +.. important:: To help explain :ref:`dynamic function arguments ` a little more, you can see that the previous call used the keyword argument ``q``, that is because Twitter specifies in their `search documentation `_ that the search call accepts the parameter "q". You can pass multiple keyword arguments. The search documentation also specifies that the call accepts the parameter "result_type" .. code-block:: python diff --git a/docs/usage/special_functions.rst b/docs/usage/special_functions.rst index 301abd35..70d2f36c 100644 --- a/docs/usage/special_functions.rst +++ b/docs/usage/special_functions.rst @@ -10,7 +10,7 @@ This section covers methods to are part of Twython but not necessarily connected Cursor ------ -This function returns a generator for Twitter API endpoints that are able to be pagintated in some way (either by cursor or since_id parameter) +This function returns a generator for Twitter API endpoints that are able to be paginated in some way (either by cursor or since_id parameter) The Old Way ^^^^^^^^^^^ @@ -91,7 +91,7 @@ will be replaced with: google.com is #cool, lol! @mikehelmick shd #checkitout. Love, @__twython__ $IBM github.com pic.twitter.com/N6InAO4B71 -.. note:: When converting the string to HTML we add a class to each HTML tag so that you can maninpulate the DOM later on. +.. note:: When converting the string to HTML we add a class to each HTML tag so that you can manipulate the DOM later on. - For urls that are replaced we add ``class="twython-url"`` to the anchor tag - For media urls that are replaced we add ``class="twython-media"`` to the anchor tag diff --git a/docs/usage/starting_out.rst b/docs/usage/starting_out.rst index 7bb3d94e..6dc278cd 100644 --- a/docs/usage/starting_out.rst +++ b/docs/usage/starting_out.rst @@ -74,7 +74,7 @@ Handling the Callback .. note:: If your application is a Desktop or Mobile Application *oauth_verifier* will be the PIN code -After they authorize your application to access some of their account details, they'll be redirected to the callback url you specified in ``get_autentication_tokens`` +After they authorize your application to access some of their account details, they'll be redirected to the callback url you specified in ``get_authentication_tokens`` You'll want to extract the ``oauth_verifier`` from the url. diff --git a/tests/test_endpoints.py b/tests/test_endpoints.py index ecdd5537..146860e4 100644 --- a/tests/test_endpoints.py +++ b/tests/test_endpoints.py @@ -119,7 +119,7 @@ def test_get_sent_messages(self): @unittest.skip('skipping non-updated test') def test_send_get_and_destroy_direct_message(self): - """Test sending, getting, then destory a direct message succeeds""" + """Test sending, getting, then destroy a direct message succeeds""" message = self.api.send_direct_message(screen_name=protected_twitter_1, text='Hey d00d! %s\ ' % int(time.time())) @@ -395,7 +395,7 @@ def test_create_update_destroy_list_add_remove_list_members(self): @unittest.skip('skipping non-updated test') def test_get_list_memberships(self): - """Test list of memberhips the authenticated user succeeds""" + """Test list of membership the authenticated user succeeds""" self.api.get_list_memberships() @unittest.skip('skipping non-updated test') diff --git a/twython/endpoints.py b/twython/endpoints.py index e35088d2..60aa060d 100644 --- a/twython/endpoints.py +++ b/twython/endpoints.py @@ -230,7 +230,7 @@ def upload_video(self, media, media_type, media_category=None, size=None, check_ response = self.post(upload_url, params=params) - # Only get the status if explicity asked to + # Only get the status if explicitly asked to # Default to False if check_progress: diff --git a/twython/streaming/api.py b/twython/streaming/api.py index 6073abbe..63f45c5a 100644 --- a/twython/streaming/api.py +++ b/twython/streaming/api.py @@ -171,7 +171,7 @@ def on_success(self, data): # pragma: no cover https://developer.twitter.com/en/docs/tweets/filter-realtime/guides/streaming-message-types for messages sent along in stream responses. - :param data: data recieved from the stream + :param data: data received from the stream :type data: dict """ return True