TEN-framework / TEN-framework/ten-framework
The call restrictions of ten_env APIs need to be clarified
Open
Nobody has claimed this yet.
enhancement
ten-framework
- Dominant language
- Python
- Stars
- 11.1k
- Forks
- 1.4k
- Avg merge
- 2d 15m
- Merged PRs (30d)
- 22
Description
The ten_env APIs are not safe to be called in any context or in any thread, so we need to clarify these call restrictions and the exceptions or error messages under incorrect calls.
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 locating the ten_env APIs and the existing handling or messages for calls made from unsupported contexts or threads. Document the call restrictions, exceptions, and incorrect-call errors. Done means the API guidance clearly states where each call is allowed and what happens when it is not.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100