search

ssbc / ssb-friends

Manages the SSB social graph
MIT License
23 stars 6 forks source link

doc drive week 7: module triage #35

Closed austinfrey closed 5 years ago

austinfrey commented 5 years ago

rate the current state of the documentation out of 10.

7/10

is it clear what this is used for? is anything confusing or weird?

yes, this seems very approachable to me.

is there api documentation?

yes

read code, do you see any undocumented methods?

no, all methods listed in the plugin manifest are documented

for a method is there any undocumented options?

hopStream looks like it can take additional options. see layered-graph#hopStream hops can also accepts additional options. see layered-graph#getHops

mixmix commented 5 years ago

agree it's important to know can call sbot.friends.hops(opts, cb)

opts seems to take : { start, reverse, max }

stale[bot] commented 5 years ago

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?