diff --git a/deezer/client.py b/deezer/client.py index a00d0a0f..51a4cb82 100644 --- a/deezer/client.py +++ b/deezer/client.py @@ -133,7 +133,7 @@ def request( :param path: The path to make the API call to (e.g. 'artist/1234'). :param parent: A reference to the parent resource, to avoid fetching again. :param resource_type: The resource class to use as top level. - :param params: Query parameters to add the the request + :param params: Query parameters to add to the request """ if self.access_token is not None: params["access_token"] = str(self.access_token) @@ -183,7 +183,7 @@ def get_chart(self) -> Chart: """ Get overall charts for tracks, albums, artists and playlists. - Combines charts of several resources in one endpoint. + Combine charts of several resources in one endpoint. :returns: a :class:`~deezer.resources.Chart` instance. """ @@ -271,7 +271,7 @@ def get_podcast(self, podcast_id: int) -> Podcast: def get_radio(self, radio_id: int) -> Radio: """ - Get the radio with the given ID.. + Get the radio with the given ID. :returns: a :class:`~deezer.resources.Radio` object """ @@ -458,7 +458,7 @@ def search( :param query: the query to search for, this is directly passed as q query. :param strict: whether to disable fuzzy search and enable strict mode. - :param ordering: see Deezer's API docs for possible values. + :param ordering: see Deezer API docs for possible values. :param artist: parameter for the advanced search feature. :param album: parameter for the advanced search feature. :param track: parameter for the advanced search feature. @@ -501,7 +501,7 @@ def search_albums( :param query: the query to search for, this is directly passed as q query. :param strict: whether to disable fuzzy search and enable strict mode. - :param ordering: see Deezer's API docs for possible values. + :param ordering: see Deezer API docs for possible values. :param index: the offset of the first object you want to get. :param limit: the maximum number of objects to return. :return: list of :class:`~deezer.resources.Album` instances. @@ -528,7 +528,7 @@ def search_artists( :param query: the query to search for, this is directly passed as q query. :param strict: whether to disable fuzzy search and enable strict mode. - :param ordering: see Deezer's API docs for possible values. + :param ordering: see Deezer API docs for possible values. :param index: the offset of the first object you want to get. :param limit: the maximum number of objects to return. :return: list of :class:`~deezer.resources.Album` instances. diff --git a/deezer/contrib/tornado.py b/deezer/contrib/tornado.py index a5625c82..08785b82 100644 --- a/deezer/contrib/tornado.py +++ b/deezer/contrib/tornado.py @@ -1,6 +1,6 @@ """ Implements an async tornado client class to query the -`Deezer API `_ +`Deezer API `_ """ import json from typing import Optional, Type @@ -48,7 +48,7 @@ def request( :param path: The path to make the API call to (e.g. 'artist/1234'). :param parent: A reference to the parent resource, to avoid fetching again. :param resource_type: The resource class to use as top level. - :param params: Query parameters to add the the request + :param params: Query parameters to add to the request """ if self.access_token is not None: params["access_token"] = str(self.access_token) diff --git a/docs/source/api_reference/toc.rst b/docs/source/api_reference/toc.rst index c84a7047..e5611844 100644 --- a/docs/source/api_reference/toc.rst +++ b/docs/source/api_reference/toc.rst @@ -1,8 +1,7 @@ Reference ========= -This is the auto-generated documentation for all the main modules -in the library. +This is the auto-generated documentation for all the main modules in the library. :Release: |version| :Date: |today| diff --git a/docs/source/asynchronous.md b/docs/source/asynchronous.md index dcfb6c03..4902c9d3 100644 --- a/docs/source/asynchronous.md +++ b/docs/source/asynchronous.md @@ -1,9 +1,8 @@ # Asynchronous client -You also can use an -{class}`AsyncClient ` with tornado, which requires an optional dependency. You should install with `pip install deezer-python[tornado]`. +You also can use an {class}`AsyncClient ` with tornado, which requires an optional dependency. You should install with `pip install deezer-python[tornado]`. -Then, making a request would look like this: +Then, doing a request would look like this: ```python >>> from tornado.gen import coroutine @@ -21,6 +20,4 @@ Then, making a request would look like this: Monkey Business ``` -The {class}`AsyncClient ` implements the same methods as the main -{class}`Client ` class -and would return the same resources. +The {class}`AsyncClient ` implements the same methods as the main {class}`Client ` class and would return the same resources. diff --git a/docs/source/index.md b/docs/source/index.md index e6d33233..833d8595 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,7 +1,6 @@ -# Deezer Python\'s documentation +# Deezer Python documentation -Deezer-Python: a friendly wrapper around the [Deezer -API](http://developers.deezer.com/api). +Deezer-Python: a friendly wrapper around the [Deezer API](http://developers.deezer.com/api). ```{toctree} :caption: Installation & Usage diff --git a/docs/source/installation.md b/docs/source/installation.md index 10893591..9cd393fd 100644 --- a/docs/source/installation.md +++ b/docs/source/installation.md @@ -1,7 +1,6 @@ # Installation -The package is published on [PyPI](https://pypi.org/project/deezer-python/) -and can be installed with `pip` (or any equivalent): +The package is published on [PyPI](https://pypi.org/project/deezer-python/) and can be installed with `pip` (or any equivalent): ```bash pip install deezer-python