search

sCrypt-Inc / scryptTS-docs

https://docs.scrypt.io
11 stars 8 forks source link

add detailed comments for all references #31

Closed xhliu closed 1 year ago

xhliu commented 1 year ago

Do it after https://github.com/sCrypt-Inc/scryptTS-docs/issues/19 !

Many r not documented like https://scrypt.io/scrypt-ts/reference/classes/HashedMap#size

msinkec commented 1 year ago

I believe the reference docs are auto-generated so it would make sense to simply include docstrings in the pages. @zhfnjust should know more

xhliu commented 1 year ago

Yes, add them in source code, not in the doc since they can then be auto generated.

msinkec commented 1 year ago

I believe @zhfnjust is already working on exactly this so I'll re-assign the issue over to him.

zhfnjust commented 1 year ago

Fixed in https://github.com/sCrypt-Inc/scrypt-ts/pull/293