Skip to content

Commit

Permalink
Merge pull request #129 from prjaga/pj/update_docs
Browse files Browse the repository at this point in the history
Update tape documentation
  • Loading branch information
dham authored Feb 16, 2024
2 parents a8927ca + 18f3ccc commit 9bfe70f
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions docs/source/documentation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 9bfe70f

Please sign in to comment.