protocolbuffers / protocolbuffers/protobuf-javascript

JavaScript documentation missing methods

Offen
#86 1 Kommentar 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation good first issue javascript P3 triaged
Vorherrschende Sprache
JavaScript
Sterne
471
Forks
91
Ø Merge
3 Std. 57 Min.
Gemergte PRs (30 T.)
2

Beschreibung

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?

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der verknüpften JavaScript-Referenz zum generierten Code und vergleiche deren Dokumentation zu wiederholten Feldern mit den im Issue aufgeführten Methoden. Ermittle, wo diese Dokumentation im Repository gepflegt wird; die Arbeit ist abgeschlossen, wenn addFooList(), getFooList_asU8() und getFooList_asB64() korrekt dokumentiert sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.