Skip to content

Commit

Permalink
fixup! align docstrings (ignore_errors/yields) in data backends
Browse files Browse the repository at this point in the history
  • Loading branch information
SergioSim committed Nov 17, 2023
1 parent d5c7d3c commit c7b75e3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
3 changes: 1 addition & 2 deletions src/ralph/backends/data/async_es.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,7 @@ async def read( # noqa: PLR0912, PLR0913
dict: The next JSON parsed document if `raw_output` is False.
Raise:
BackendException: If a failure occurs during Elasticsearch connection or
during encoding documents and `ignore_errors` is set to `False`.
BackendException: If a failure occurs during Elasticsearch connection.
"""
if raw_output:
documents = self.read(
Expand Down
4 changes: 2 additions & 2 deletions src/ralph/backends/data/swift.py
Original file line number Diff line number Diff line change
Expand Up @@ -193,8 +193,8 @@ def read( # noqa: PLR0913
bytes: If `raw_output` is True.
Raise:
BackendException: If a failure during the read operation occurs and
`ignore_errors` is set to `False`.
BackendException: If a failure during the read operation occurs or
during encoding records and `ignore_errors` is set to `False`.
BackendParameterException: If a backend argument value is not valid.
"""
if query.query_string is None:
Expand Down

0 comments on commit c7b75e3

Please sign in to comment.