From 18f3ccc5cea71a1db1cec66c7e9726ed7468dd3b Mon Sep 17 00:00:00 2001 From: Prem Jagadeesh Date: Sat, 20 Jan 2024 17:44:37 +0000 Subject: [PATCH] Update tape documentation --- docs/source/documentation/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/source/documentation/index.rst b/docs/source/documentation/index.rst index 06f72727..759fc31e 100644 --- a/docs/source/documentation/index.rst +++ b/docs/source/documentation/index.rst @@ -361,8 +361,7 @@ a tape. The current working tape can be set and retrieved with the functions :py :py:func:`get_working_tape`. Annotation can be temporarily disabled using :py:func:`pause_annotation` and enabled again using :py:func:`continue_annotation`. -Note that if you call :py:func:`pause_annotation` twice, then :py:func:`continue_annotation` must be called twice -to enable annotation. Due to this, the recommended annotation control functions are :py:class:`stop_annotating` and :py:func:`no_annotations`. +It is recommended to use :py:class:`stop_annotating` and :py:func:`no_annotations` for annotation control. :py:class:`stop_annotating` is a context manager and should be used as follows .. code-block:: python