mattrobenolt / mattrobenolt/connect-python

Propagate comments to docstrings

Open
#13 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
29
Forks
0
PR merge metrics
No merged PRs in 30d

Description

The plugin is not propagating docstring from the proto file to the service handler methods.

Related — python plugin with pyi also seems to not propagate comments to docstrings on the types.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the Python plugin code that generates service handler methods from proto files, then inspect how comments are represented and emitted. Check the related Python plugin and pyi type generation path as well; done means proto comments appear in the generated handler and type docstrings.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.