Adds docs for update() function to Reducer

[elijahbenizzy]

Requested by @gamarin2!

---

Important

Add docstring to update() method in Reducer class in burr/core/action.py to explain state update process and parameters.

• Docs:
  • Add docstring to update() method in Reducer class in burr/core/action.py.
  • Explains state update process, immutability, and two-step action context.
  • Describes parameters result and state, and return value State.

^{This description was created by for d7a5822. It will automatically update as commits are pushed.}

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to d7a5822 in 10 seconds

More details

• Looked at 24 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 1 drafted comments based on config settings.

1. burr/core/action.py:129

• Draft comment:
  Consider clarifying that the state is immutable and a new state object must be returned, rather than modifying the existing state in place.
• Reason this comment was not posted:
  Confidence changes required: 33%
  The docstring for the update method in the Reducer class is clear and informative. However, it could benefit from a minor clarification regarding the immutability of the state.

Workflow ID: wflow_jiyHpfZg1KXV7DdU

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

[github-actions]

A preview of is uploaded and can be seen here:

✨ https://burr.dagworks.io/pull/447 ✨

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/DAGWorks-Inc/burr/tree/gh-pages/pull/447/