@@ -56,8 +56,13 @@ these instances may acquire a lock.
5656 a **method of coordination ** for clients that rely on versioning facilities
5757 and thus **not a reliable security mechanism ** in any manner.
5858
59- Checkpoints
60- -----------
59+ For advanced use of the locking mechanism, read about:
60+
61+ - :meth: `ixmp4.core.run.Run.lock `
62+ - :meth: `ixmp4.core.run.Run.unlock `
63+
64+ Checkpoints and Reversion
65+ -------------------------
6166
6267Checkpoints are used to label important transactions in the transaction history
6368as to provide "anchors" to revert to. They are created automatically at the exit
@@ -74,14 +79,20 @@ created at any other point.
7479 # > Checkpoint "Add data" created
7580
7681 If an exception occurs within a :meth: `~ixmp4.core.run.Run.transact ` block,
77- data in the run will be rolled back to the latest checkpoint on platforms
82+ data in the run will be reverted to the latest checkpoint on platforms
7883that support versioning.
7984
85+ To manually revert to a past state, use the ``revert() `` methods on
86+ :class: `~ixmp4.core.run.Run ` and :class: `~ixmp4.core.checkpoint.Checkpoint `.
87+
88+ - :meth: `ixmp4.core.run.Run.revert `
89+ - :meth: `ixmp4.core.checkpoint.Checkpoint.revert `
90+
8091Checkpoint Views
8192----------------
8293
8394Checkpoint views provide read-only access to run data at a specific checkpoint.
84- Access them through `` run.checkpoints[checkpoint_id] ``.
95+ Access them through :class: ` ~ixmp4.core.run.RunCheckpoints ` / :attr: ` ~ixmp4.core. run.Run. checkpoints` `.
8596
8697.. autoclass :: ixmp4.core.checkpoint.Checkpoint
8798 :members:
0 commit comments