OpenFn / OpenFn/kit

Lazy state: improve clarity

Open
#838 0 comments 0 reactions 1 assignee View on GitHub

@josephjclark is already working on this.

Since Dec 4, 2024.

DevX
Dominant language
TypeScript
Stars
21
Forks
23
Avg merge
1d 22h
Merged PRs (30d)
17

Description

We need to improve clarity on a few things in lazy state

  • Lazy state only works at the top level (not inside callbacks). I don't think we'll enforce this (I don't know how well we can?!) but we can document it at least. We should also make sure that the compiler stops traversal inside a new scope.
  • Set up some clear wording that lazy state basically only applies to the parent function - it won't smartly walk up to the nearest operation. See discussion at https://github.com/OpenFn/kit/issues/745#issuecomment-2514360872

This means updating docs, and maybe some unit tests in this repo

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.