js-waku icon indicating copy to clipboard operation
js-waku copied to clipboard

chore: ensure documentation for common functions are available in https://js.waku.org

Open adklempner opened this issue 2 years ago • 3 comments

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

adklempner avatar Nov 09 '23 16:11 adklempner

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.

chair28980 avatar Nov 14 '23 16:11 chair28980

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.

danisharora099 avatar Nov 14 '23 17:11 danisharora099

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.

fryorcraken avatar Nov 15 '23 04:11 fryorcraken