protocolbuffers / protocolbuffers/protocolbuffers.github.io
C++ API docs out of date?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- HTML
- Sterne
- 69
- Forks
- 179
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
The C++ API documentation does not appear to mirror the new absl::string_view return types introduced in v30.
https://protobuf.dev/support/migration/#string_view-return-type - describes the change in return types
https://protobuf.dev/reference/cpp/api-docs/google.protobuf.descriptor/#Descriptor - indicates returning const std::string&
https://github.com/protocolbuffers/protobuf/blob/01331f9e51775b7e11f8b61d778ea98ddb522ad1/src/google/protobuf/descriptor.h#L362 - returns absl::string_view
Beitragsleitfaden
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
Vergleiche den Migrationsleitfaden mit der C++-API-Dokumentation für die Descriptor-Seite und die referenzierte Zeile 362 in descriptor.h. Überprüfe, welche dokumentierten Rückgabetypen von den v30-Signaturen mit absl::string_view abweichen, aktualisiere die betroffene API-Dokumentation und bestätige, dass die Seiten den Header durchgängig widerspiegeln.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- cpp
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100