Skip to content

Fix docstring: remove non-existent parameter and correct typos #431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 24, 2025
Merged

Fix docstring: remove non-existent parameter and correct typos #431

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion taskiq/decor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ def kicker(self) -> AsyncKicker[_FuncParams, _ReturnType]:
"""
This function returns kicker object.

Kicker is a object that can modify kiq request
Kicker is an object that can modify kiq request
before sending it.

:return: AsyncKicker instance.
Expand Down
1 change: 0 additions & 1 deletion taskiq/kicker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,6 @@ async def schedule_by_cron(
:param source: schedule source.
:param cron: cron expression.
:param args: function's args.
:param cron_offset: cron offset.
:param kwargs: function's kwargs.
:return: schedule id.
Expand Down
2 changes: 1 addition & 1 deletion taskiq/serialization.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,7 +336,7 @@ def exception_to_python(
"""Convert serialized exception to Python exception.

:param exc: encoded exception
:raises SecurityError: exception isn't indead an exception
:raises SecurityError: exception isn't indeed an exception
:return: decoded exception or None
"""
if not exc:
Expand Down
2 changes: 1 addition & 1 deletion taskiq/task.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ async def wait_result(
ready. And if it is it returns the result.
It may throw TaskiqResultTimeoutError if
task didn't became ready in provided
task didn't become ready in provided
period of time.
:param check_interval: How often checks are performed.
Expand Down