diff options
Diffstat (limited to 'docs/docs/concepts/history.md')
| -rw-r--r-- | docs/docs/concepts/history.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/docs/concepts/history.md b/docs/docs/concepts/history.md index bf72d2b4..7f028e14 100644 --- a/docs/docs/concepts/history.md +++ b/docs/docs/concepts/history.md @@ -8,6 +8,6 @@ The **history** is the ordered record of all past steps ## Details
-**TODO: Nate to brain dump anything important to know and Ty to shape into paragraphs**
+History stores a list ("timeline") of HistoryNodes. Each HistoryNode contains the Step with parameters, the Observation returned by the step, and the depth of the step (just so we can understand the tree structure, and what called what, and display as a tree if we wanted). History has a current_index, which can be smaller than the length of the timeline if some steps have been reversed (in which case GUI displays them with lower opacity). History class mostly responsible for maintaining order of history during reversals, grabbing most recent steps, or other things that should be bottlenecked through reliable access methods.
-- What step data and metadata is stored in the history?
\ No newline at end of file +- What step data and metadata is stored in the history?
|