mattrobenolt / mattrobenolt/connect-python
Propagate comments to docstrings
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 29
- Forks
- 0
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne damit, den Python-Plugin-Code zu lokalisieren, der aus proto-Dateien Methoden für Service-Handler generiert, und untersuche anschließend, wie Kommentare dargestellt und ausgegeben werden. Prüfe außerdem den zugehörigen Python-Plugin- und pyi-Typgenerierungspfad; abgeschlossen ist die Aufgabe, wenn proto-Kommentare in den generierten Handler- und Typ-Docstrings erscheinen.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- python
- Bereich
- tooling
- Issue-Typ
- Bug
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100