search

SetProtocol / set.js

Javascript library for the Set Protocol V2
Apache License 2.0
33 stars 14 forks source link

JSDoc comments for Position #82

Closed rootulp closed 2 years ago

rootulp commented 2 years ago

While working on https://github.com/SetProtocol/index-ui/pull/422 I would've liked to see JSDoc comments for Position. I found docs on https://docs.tokensets.com/contracts/core-contracts/set-token#getpositions so I added them inline so devs can see them while using types from this package.

If reviewers approve of a change like this, I can add doc comments to other types in this package. I would fetch docs from https://docs.tokensets.com/contracts but open to other ideas.

cgewecke commented 2 years ago

Am going to merge this one - if you'd like to pursue improving the TS docs please feel free.