protocolbuffers / protocolbuffers/protocolbuffers.github.io

C++ API docs out of date?

Aperta
#287 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
HTML
Stelle
69
Fork
179
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Confronta la guida alla migrazione con la documentazione dell’API C++ della pagina Descriptor e con la riga 362 di descriptor.h a cui si fa riferimento. Verifica quali tipi restituiti documentati differiscono dalle firme v30 con absl::string_view, aggiorna la documentazione dell’API interessata e conferma che le pagine rispecchino coerentemente l’header.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.