josephg/node-foundationdb

Port documentation into typescript doc comments

オープン

#26 opened on 2019/03/15

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)TypeScript (20 件のフォーク)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (129 個のスター)
PR merge metrics
 (30d に merged PR はありません)

説明

There's lots of transaction & database methods which are missing documentation comments.

We should do a pass adding typescript tsdoc - compatible doc comments for all the normal function in (at a minimum) lib/transaction.ts and lib/database.ts.

This documentation is picked up by documentation tools and by editors (like vs code), which makes it very handy while using the API.

コントリビューターガイド