Skip to content

Commit 63e9b82

Browse files
author
Max Zhenzhera
committed
update doc
1 parent 3b3c896 commit 63e9b82

5 files changed

Lines changed: 9 additions & 2 deletions

File tree

freedictionaryapi/clients/async_client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,7 @@ async def fetch_api_response(self, url: str) -> typing.Tuple[int, typing.Any]:
9292
:type url: :obj:`str`
9393
9494
:return: tuple of:
95+
9596
- response status code;
9697
- python object loaded from API response with JSON decoding.
9798
:rtype: :obj:`tuple[int, Any]`

freedictionaryapi/clients/base_async_client.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,8 @@ async def fetch_api_response(self, url: str) -> typing.Tuple[int, typing.Any]:
9494
:param url: url that is generated by input params in invoked function
9595
:type url: :obj:`str`
9696
97-
:return: tuple of
97+
:return: tuple of:
98+
9899
- response status code;
99100
- python object loaded from API response with JSON decoding.
100101
:rtype: :obj:`tuple[int, Any]`

freedictionaryapi/clients/base_client_interface.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,10 @@ def _generate_url(self, word: str, language_code: typing.Optional[LanguageCodes]
130130
:param language_code: language of the searched word
131131
:type language_code: :obj:`Optional[LanguageCodes]`
132132
133-
:return: tuple of generated URL and used language code
133+
:return: tuple of:
134+
135+
- generated URL;
136+
- used language code.
134137
:rtype: :obj:`Union[str, LanguageCodes]`
135138
"""
136139

freedictionaryapi/clients/base_sync_client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,7 @@ def fetch_api_response(self, url: str) -> typing.Tuple[int, typing.Any]:
9696
:type url: :obj:`str`
9797
9898
:return: tuple of:
99+
99100
- response status code;
100101
- python object loaded from API response with JSON decoding.
101102
:rtype: :obj:`tuple[int, Any]`

freedictionaryapi/clients/sync_client.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,7 @@ def fetch_api_response(self, url: str) -> typing.Tuple[int, typing.Any]:
7777
:type url: :obj:`str`
7878
7979
:return: tuple of:
80+
8081
- response status code;
8182
- python object loaded from API response with JSON decoding.
8283
:rtype: :obj:`tuple[int, Any]`

0 commit comments

Comments
 (0)