protocolbuffers / protocolbuffers/protocolbuffers.github.io

C++ API docs out of date?

Abierto
#287 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
HTML
Estrellas
69
Forks
179
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

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

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Compara la guía de migración con la documentación de la API de C++ de la página Descriptor y la línea 362 referenciada de descriptor.h. Verifica qué tipos de retorno documentados difieren de las firmas de v30 con absl::string_view, actualiza la documentación de la API afectada y confirma que las páginas reflejan el header de forma coherente.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
cpp
Área
documentation
Tipo de issue
Documentación
Dificultad
2/5
Tiempo estimado
1-3 horas
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.