protocolbuffers / protocolbuffers/protobuf-javascript
JavaScript documentation missing methods
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 471
- Forks
- 91
- Avg merge
- 3h 57m
- Merged PRs (30d)
- 2
Description
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?
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked JavaScript generated-code reference and compare its repeated-field documentation with the methods listed in the issue. Determine where this documentation is maintained in the repository; the work is complete when addFooList(), getFooList_asU8(), and getFooList_asB64() are accurately documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100