search

dolfin-adjoint / pyadjoint

The algorithmic differentation tool pyadjoint and add-ons.
GNU Lesser General Public License v3.0
91 stars 37 forks source link

Update tape documentation #129

Closed prjaga closed 8 months ago

prjaga commented 9 months ago

Documentation used to be

Note that if you call pause_annotation() twice, then continue_annotation() must be called twice to enable annotation. Due to this, the recommended annotation control functions are stop_annotating and no_annotations().

updated this to reflect changes in #111 to

Annotation can be temporarily disabled using pause_annotation() and enabled again using continue_annotation(). It is recommended to use stop_annotating and no_annotations() for annotation control.

as there is no counter anymore there is no need to call these functions twice to re-enable annotating.

dham commented 8 months ago

Thank you for catching this @prjaga