grpc / grpc/grpc

Add gRPC Python API Documentation Sanity Checks

Open
#18,619 2 comments 0 reactions 1 assignee Claimed by @gnossen View on GitHub
disposition/help wanted disposition/never stale kind/enhancement lang/Python priority/P3
Dominant language
C++
Stars
45.3k
Forks
11.4k
Avg merge
2d 12h
Merged PRs (30d)
47

Description

It is currently the responsibility of developers to remember to add each new object added to the surface API to [`grpc.rst`](https://github.com/grpc/grpc/blob/dd4830eae80143f5b0a9a3a1a024af4cf60e7d02/doc/python/sphinx/grpc.rst). It is entirely possible for this to be forgotten, especially as the project changes hands.

One solution to this problem would be to automatically generated the docs. However, as @lidizheng pointed out to me, we cannot do this *and* maintain logical human-curated categories within the docs.

An alternative would be to add a simple sanity check ensuring that every element of the surface API is represented in the docs.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.