protocolbuffers / protocolbuffers/protobuf-javascript

JavaScript documentation missing methods

Abierto
#86 1 comentario 1 reacción 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

documentation good first issue javascript P3 triaged
Lenguaje dominante
JavaScript
Estrellas
471
Forks
91
Merge medio
3 h 57 min
PR fusionados (30 d)
2

Descripción

Hi!

I noticed the JS generated code documentation (https://developers.google.com/protocol-buffers/docs/reference/javascript-generated#repeated) was missing information about the following methods that are being generated by the latest protoc:

addFooList(): Adds value at specified index in list

And for repeated bytes:

getFooList_asU8(): Gets the array of bytes, with each value converted to Uint8Array
getFooList_asB64(): Gets the array of bytes, with each value converted to Base64 strings

I looked around in this repo and couldn't find anywhere to contribute this, could someone point me in the right direction?

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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

Comienza con la referencia vinculada del código generado de JavaScript y compara su documentación de campos repetidos con los métodos enumerados en el issue. Determina dónde se mantiene esta documentación en el repositorio; el trabajo estará completo cuando addFooList(), getFooList_asU8() y getFooList_asB64() estén documentados correctamente.

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

Evaluación

Stack tecnológico
javascript
Á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
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.