When should we use execute(...), when should we use combine(...) ?
Open
Nobody has claimed this yet.
question
- Dominant language
- JavaScript
- Stars
- 24
- Forks
- 41
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 12
Description
Can we expand the documentation for combine to explain when it should be used vis-a-vis execute.
Combine
https://github.com/OpenFn/adaptors/blob/main/packages/common/src/Adaptor.js#L265-L277
Execute
https://github.com/OpenFn/adaptors/blob/main/packages/common/src/Adaptor.js#L20-L28
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reading the combine implementation at packages/common/src/Adaptor.js#L265-L277 and the execute implementation at #L20-L28. Compare their current roles and document when each should be used, including the distinction requested in the issue. Done means the documentation clearly explains the choice between combine and execute.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100