josephg/node-foundationdb

Port documentation into typescript doc comments

Open

#26 opened on Mar 15, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20 forks)github user discovery
enhancementgood first issuehelp wanted

Repository metrics

Stars
 (129 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

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.

Contributor guide

Research direction
Look at the existing TypeScript files (lib/transaction.ts, lib/database.ts) and add TSDoc compatible doc comments to all public functions and methods, following the conventions used elsewhere in the codebase.
Tech stack
typescript
Domain
apibackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85