js-waku
js-waku copied to clipboard
chore: ensure documentation for common functions are available in https://js.waku.org
This is a feature request
Problem
Some of the functions used by builders do not have any comments/JSDocs added to them. These can be useful for learning about how the library works without leaving a code editor or the codebase.
Proposed Solutions
Add comments/typedocs to the most commonly used functions including:
- functions to create a filter subscription
- functions to push messages to light push
Notes
It makes sense to wait for first minor/major release to add this
Closing issue, based on feedback in conversation with hackathon participants, they have signaled that examples of implementations are more useful than comments in the code.
Closing issue, based on feedback in conversation with hackathon participants, they have signaled that examples of implementations are more useful than comments in the code.
Well, we can have both. I'm in the favour of commenting the codebase well.
Already present:
- https://js.waku.org/functions/_waku_core.createDecoder.html
- https://js.waku.org/functions/_waku_core.createEncoder.html
Indeed I can't find createSubscription in the docs. @danisharora099 to ensure it's documented as you update the API
some for light push, it's probably hidden in the code.