protocolbuffers / protocolbuffers/protocolbuffers.github.io
C++ API docs out of date?
Personne n'a encore pris cette issue.
- Langage dominant
- HTML
- Étoiles
- 69
- Forks
- 179
- Métriques de merge des PR
- Aucune PR mergée en 30 j
Description
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
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Piste de recherche
Comparez le guide de migration avec la documentation de l’API C++ de la page Descriptor et la ligne 362 référencée de descriptor.h. Vérifiez quels types de retour documentés diffèrent des signatures v30 utilisant absl::string_view, mettez à jour la documentation de l’API concernée et confirmez que les pages reflètent systématiquement le header.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- cpp
- Domaine
- documentation
- Type d'issue
- Documentation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Activité
- À l'abandon
- Clarté
- Plutôt claire
- Accessibilité débutants
- 45/100