Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Dreamsorcerer committed Jul 23, 2024
1 parent 1585f26 commit 312810a
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ Usage example
Shielding tasks with a scheduler
================================

It is typically recommended to use :func:`asyncio.shield` to protect tasks
It is typically recommended to use :function:`asyncio.shield` to protect tasks
from cancellation. However, the inner shielded tasks can't be tracked and
are therefore at risk of being cancelled during application shutdown.

Expand Down
2 changes: 1 addition & 1 deletion docs/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ Scheduler

Protect an awaitable from being cancelled.

This is a drop-in replacement for :func:`asyncio.shield`, with the
This is a drop-in replacement for :function:`asyncio.shield`, with the
addition of tracking the shielded task in the scheduler. This can be
used to ensure that shielded tasks will actually be completed on
application shutdown.
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ For further information read :ref:`aiojobs-quickstart`,
Shielding tasks with a scheduler
--------------------------------

It is typically recommended to use :func:`asyncio.shield` to protect tasks
It is typically recommended to use :function:`asyncio.shield` to protect tasks
from cancellation. However, the inner shielded tasks can't be tracked and
are therefore at risk of being cancelled during application shutdown.

Expand Down

0 comments on commit 312810a

Please sign in to comment.