channable / channable/opsqueue

Improve documentation of design decisions regarding the async runtime

Open
#7 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
96
Forks
2
Avg merge
1h 2m
Merged PRs (30d)
2

Description

There are some design decisions and potential footguns we avoid in the implementation of the Python client.

As was pointed out in PR #6, the documentation of these could be improved.
That PR was merged to have the bugfixes online early, but the feedback w.r.t. the documentation still should be applied.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reading PR #6 and the async-runtime implementation to identify the design decisions and potential footguns referenced in the issue. Update the project documentation to explain those points clearly, with completion shown by the documentation covering the feedback that remained after PR #6 was merged.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.