Corrections to Grammar Errors and Typos in Documentation (#1017)

* Fixed grammar errors and typos.

* Update CHANGELOG.md to mention documentation typo corrections.

---------

Co-authored-by: Stéphane Bruckert <stephane.bruckert@gmail.com>
This commit is contained in:
wouldubeandStéphane Bruckert authored and GitHub committed 2024-05-30 19:37:39 +01:00
1 parent 126da62dd0
commit a810edf5da
5 files changed
+26 -30

No files matched your search

+3 -3
View File
@@ -100,7 +100,7 @@ class Spotify:
#
# Unfortunately the IANA specification is out of date and doesn't include the new types
# show and episode. Additionally, for the user URI, it does not specify which characters
# are valid for usernames, so the assumption is alphanumeric which coincidentially are also
# are valid for usernames, so the assumption is alphanumeric which coincidentally are also
# the same ones base-62 uses.
# In limited manual exploration this seems to hold true, as newly accounts are assigned an
# identifier that looks like the base-62 of all other IDs, but some older accounts only have
@@ -1751,7 +1751,7 @@ class Spotify:
tlist = [self._get_id("track", t) for t in tracks]
results = self._get("audio-features/?ids=" + ",".join(tlist))
# the response has changed, look for the new style first, and if
# its not there, fallback on the old style
# it's not there, fallback on the old style
if "audio_features" in results:
return results["audio_features"]
else:
@@ -1939,7 +1939,7 @@ class Spotify:
def add_to_queue(self, uri, device_id=None):
""" Adds a song to the end of a user's queue
If device A is currently playing music and you try to add to the queue
If device A is currently playing music, and you try to add to the queue
and pass in the id for device B, you will get a
'Player command failed: Restriction violated' error
I therefore recommend leaving device_id as None so that the active device is targeted
+4 -4
View File
@@ -41,7 +41,7 @@ class SpotifyStateError(SpotifyOauthError):
def __init__(self, local_state=None, remote_state=None, message=None,
error=None, error_description=None, *args, **kwargs):
if not message:
message = ("Expected " + local_state + " but recieved "
message = ("Expected " + local_state + " but received "
+ remote_state)
super(SpotifyOauthError, self).__init__(message, error,
error_description, *args,
@@ -310,7 +310,7 @@ class SpotifyOAuth(SpotifyAuthBase):
* requests_session: A Requests session
* requests_timeout: Optional, tell Requests to stop waiting for a response after
a given number of seconds
* open_browser: Optional, whether or not the web browser should be opened to
* open_browser: Optional, whether the web browser should be opened to
authorize a user
* cache_handler: An instance of the `CacheHandler` class to handle
getting and saving cached authorization tokens.
@@ -659,7 +659,7 @@ class SpotifyPKCE(SpotifyAuthBase):
* requests_timeout: Optional, tell Requests to stop waiting for a response after
a given number of seconds
* requests_session: A Requests session
* open_browser: Optional, whether or not the web browser should be opened to
* open_browser: Optional, whether the web browser should be opened to
authorize a user
* cache_handler: An instance of the `CacheHandler` class to handle
getting and saving cached authorization tokens.
@@ -995,7 +995,7 @@ class SpotifyImplicitGrant(SpotifyAuthBase):
Authentication Code flow. Use the SpotifyPKCE auth manager instead
of SpotifyImplicitGrant.
SpotifyPKCE contains all of the functionality of
SpotifyPKCE contains all the functionality of
SpotifyImplicitGrant, plus automatic response retrieval and
refreshable tokens. Only a few replacements need to be made: