Skip to content

Commit

Permalink
docs: fix a few typos and reformat files
Browse files Browse the repository at this point in the history
  • Loading branch information
browniebroke committed Jan 6, 2022
1 parent 1e7b9e3 commit 91b8f5c
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 21 deletions.
12 changes: 6 additions & 6 deletions deezer/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.
"""
Expand Down Expand Up @@ -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
"""
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions deezer/contrib/tornado.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""
Implements an async tornado client class to query the
`Deezer API <http://developers.deezer.com/api>`_
`Deezer API <https://developers.deezer.com/api>`_
"""
import json
from typing import Optional, Type
Expand Down Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions docs/source/api_reference/toc.rst
Original file line number Diff line number Diff line change
@@ -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|
Expand Down
9 changes: 3 additions & 6 deletions docs/source/asynchronous.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Asynchronous client

You also can use an
{class}`AsyncClient <deezer.contrib.tornado.AsyncClient>` with tornado, which requires an optional dependency. You should install with `pip install deezer-python[tornado]`.
You also can use an {class}`AsyncClient <deezer.contrib.tornado.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
Expand All @@ -21,6 +20,4 @@ Then, making a request would look like this:
Monkey Business
```

The {class}`AsyncClient <deezer.contrib.tornado.AsyncClient>` implements the same methods as the main
{class}`Client <deezer.client.Client>` class
and would return the same resources.
The {class}`AsyncClient <deezer.contrib.tornado.AsyncClient>` implements the same methods as the main {class}`Client <deezer.client.Client>` class and would return the same resources.
5 changes: 2 additions & 3 deletions docs/source/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
3 changes: 1 addition & 2 deletions docs/source/installation.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 91b8f5c

Please sign in to comment.