Misleading Documentation: self in fromPromise Refers to Promise Actor, Not Parent
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- typescript
- Domain
- documentation
Research direction
Start with the linked packages/core/src/actors/promise.ts location and trace how the self parameter is passed to fromPromise's promise. Then find the documentation containing the quoted description and update it only if the implementation confirms the issue's observation. Done means the documentation accurately identifies what self refers to.
Written by the indexing model from the issue text.
Description
In the implementation of fromPromise, a self parameter is passed to the promise when it is executed. The documentation currently describes it as:
"The parent actor of the promise actor"
However, I suspect that self is actually a reference to the newly created promise actor itself.
I'm sending an event to the parent of the fromPromise actor. When I pass:
input: ({ self, context: { foo } }) => ({ foo, parent: self })
…it works as expected.
If the self parameter does indeed refer to the promise actor (not its parent), the documentation should be updated to clarify this.
- Dominant language
- MDX
- Stars
- 38
- Forks
- 93
- Avg merge
- 19h 31m
- Merged PRs (30d)
- 2
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from statelyai/docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 4/5 3-5 days Newbie friendliness 30/100
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
-
Pinia example Open
Difficulty 5/5 Over a week Newbie friendliness 20/100
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
bancolombia/sentinel#22 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
optimization optimization:agents-md-curator
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
githubnext/gh-aw-cao#13143 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 94/100
objectionary/hone-maven-plugin#1061 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
redhat-developer/rhdh-plugins#4887 · 2 comments ·