Documentation is lacking
Nobody has claimed this yet.
- Dominant language
- CMake
- Stars
- 171
- Forks
- 242
- Avg merge
- 5d 21h
- Merged PRs (30d)
- 8
Description
Here's an example of a placement driver service definition:
PD is used by both peers and clients, yet there's not a single comment that gives the reader a clue about which methods are for peers only, which are for clients, nor what each of the methods actually supposed to do.
It would be nice to have Protocol Buffers files documented, especially those that are supposed to be consumed by clients.
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 with proto/pdpb.proto, especially the placement driver service definition linked in the issue, and review its methods and consumers to distinguish peer-only and client-facing operations. Document the service methods and the other Protocol Buffers definitions intended for clients; done means readers can tell each method's purpose and intended audience.
Written by the indexing model from the issue text.
Assessment
- Domain
- backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100