daphne-project / daphne-project/daphne
Minimum of documentation for distributed run-time
- Dominant language
- C++
- Stars
- 81
- Forks
- 83
- PR merge metrics
- No merged PRs in 30d
Description
In GitLab by @pdamme on Jul 30, 2021, 19:06
Our first distributed run-time, which was contributed by !21, still lacks a minimum of documentation. To ease understanding of the code for everyone, there should at least be a short summary (can be a single sentence) for each class and major function, representing its purpose.
Contributor guide
Research direction
The issue concerns the distributed run-time contributed by !21, but names no files or tests. Locate that run-time's classes and major functions, then read their surrounding code to summarize each purpose. Done means every class and major function has at least a short purpose summary.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100