Discrepency between docs and code on `createActor` method.
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 10
- Forks
- 13
- Avg merge
- 4h 41m
- Merged PRs (30d)
- 1
Description
Doc:
const actor = pic.createActor<_SERVICE>({ idlFactory, canisterId });
Code:
createActor<T = ActorInterface>(interfaceFactory: IDL.InterfaceFactory, canisterId: Principal): Actor<T>;
The doc is the intended interface.
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.
Research direction
Start by locating the createActor declaration and the documentation example shown in the issue. Compare the implemented signature with the documented generic-call syntax and inspect nearby usage for the intended interface. Done means the code and documentation consistently expose the intended createActor interface, with relevant checks updated if they exist.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api, testing
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100