This is an automated email from the ASF dual-hosted git repository.
github-bot pushed a commit to branch gh-pages
in repository https://gitbox.apache.org/repos/asf/burr.git
The following commit(s) were added to refs/heads/gh-pages by this push:
new b636684b deploy: 447806eeb2c905d88aa85053b3a699b15b4541e6
b636684b is described below
commit b636684bcd795095f51feef5658ae317d5b775bc
Author: skrawcz <[email protected]>
AuthorDate: Sun Sep 14 04:17:00 2025 +0000
deploy: 447806eeb2c905d88aa85053b3a699b15b4541e6
---
pull/577/.doctrees/environment.pickle | Bin 439136 -> 439136 bytes
pull/577/.doctrees/reference/persister.doctree | Bin 634888 -> 634804 bytes
pull/577/reference/persister/index.html | 50 ++++++++++++-------------
pull/577/searchindex.js | 2 +-
4 files changed, 25 insertions(+), 27 deletions(-)
diff --git a/pull/577/.doctrees/environment.pickle
b/pull/577/.doctrees/environment.pickle
index 1e0aff0d..4a8b6665 100644
Binary files a/pull/577/.doctrees/environment.pickle and
b/pull/577/.doctrees/environment.pickle differ
diff --git a/pull/577/.doctrees/reference/persister.doctree
b/pull/577/.doctrees/reference/persister.doctree
index 3c0c6536..ab3b1d3a 100644
Binary files a/pull/577/.doctrees/reference/persister.doctree and
b/pull/577/.doctrees/reference/persister.doctree differ
diff --git a/pull/577/reference/persister/index.html
b/pull/577/reference/persister/index.html
index 7c88f610..1ebd46ee 100644
--- a/pull/577/reference/persister/index.html
+++ b/pull/577/reference/persister/index.html
@@ -1457,18 +1457,17 @@ so this is an attempt to fix that in a backwards
compatible way.</p>
If a sequence ID is provided, it will attempt to fetch the specific state at
that sequence.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>partition_key</strong> – The partition key.
Defaults to <cite>None</cite>. <strong>Note:</strong> The partition key
defaults to <cite>None</cite>. If a partition key was used during saving, it
must be provided</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>partition_key</strong> – The partition key. Defaults to
<cite>None</cite>.
+<strong>Note:</strong> The partition key defaults to <cite>None</cite>. If a
partition key was used during saving,
+it must be provided consistently during retrieval, or no results will be
returned.</p></li>
+<li><p><strong>app_id</strong> – Application UID to read from.</p></li>
+<li><p><strong>sequence_id</strong> – (Optional) The sequence ID to retrieve a
specific state. If not provided,
+the latest state is returned.</p></li>
+</ul>
</dd>
-</dl>
-<p>consistently during retrieval, or no results will be returned.
-:param app_id: Application UID to read from.
-:param sequence_id: (Optional) The sequence ID to retrieve a specific state.
If not provided,</p>
-<blockquote>
-<div><p>the latest state is returned.</p>
-</div></blockquote>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p>The state data if found, otherwise None.</p>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p>The state data if found, otherwise None.</p>
</dd>
</dl>
</dd></dl>
@@ -1491,22 +1490,21 @@ If a sequence ID is provided, it will attempt to fetch
the specific state at tha
<dd><p>Save the state data to the MongoDB database.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>partition_key</strong> – the partition key.
Note this could be None, but it’s up to the persistor to whether</p>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>partition_key</strong> – the partition key. Note this could be
None, but it’s up to the persistor
+to whether that is a valid value it can handle. If a partition key was used
+during saving, it must be provided consistently during retrieval, or no
+results will be returned.</p></li>
+<li><p><strong>app_id</strong> – Application UID to write with.</p></li>
+<li><p><strong>sequence_id</strong> – Sequence ID of the last executed
step.</p></li>
+<li><p><strong>position</strong> – The action name that was
implemented.</p></li>
+<li><p><strong>state</strong> – The current state of the application.</p></li>
+<li><p><strong>status</strong> – The status of this state, either “completed”
or “failed”. If “failed”, the state
+is what it was before the action was applied.</p></li>
+</ul>
</dd>
-</dl>
-<p>that is a valid value it can handle. If a partition key was used during
saving, it must be provided
-consistently during retrieval, or no results will be returned.
-:param app_id: Application UID to write with.
-:param sequence_id: Sequence ID of the last executed step.
-:param position: The action name that was implemented.
-:param state: The current state of the application.
-:param status: The status of this state, either “completed” or “failed”. If
“failed”, the state is what it was</p>
-<blockquote>
-<div><p>before the action was applied.</p>
-</div></blockquote>
-<dl class="field-list simple">
-<dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p></p>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p></p>
</dd>
</dl>
</dd></dl>
diff --git a/pull/577/searchindex.js b/pull/577/searchindex.js
index b50c608b..3626be72 100644
--- a/pull/577/searchindex.js
+++ b/pull/577/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"1. Agent application is modeled as State +
Actions \u2013>
Graph":[[27,"agent-application-is-modeled-as-state-actions-graph"]],"1. Make
your methods async":[[5,"make-your-methods-async"]],"2. Build application
\u2013> built in checkpointing &
tracking":[[27,"build-application-built-in-checkpointing-tracking"]],"2.
Implement the is_async method":[[5,"implement-the-is-async-method"]],"3. Comes
with a UI":[[27,"comes-with-a-ui"]],"3. Use async persisters with [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"1. Agent application is modeled as State +
Actions \u2013>
Graph":[[27,"agent-application-is-modeled-as-state-actions-graph"]],"1. Make
your methods async":[[5,"make-your-methods-async"]],"2. Build application
\u2013> built in checkpointing &
tracking":[[27,"build-application-built-in-checkpointing-tracking"]],"2.
Implement the is_async method":[[5,"implement-the-is-async-method"]],"3. Comes
with a UI":[[27,"comes-with-a-ui"]],"3. Use async persisters with [...]
\ No newline at end of file
