josephg/node-foundationdb

Port documentation into typescript doc comments

Ouverte

#26 ouverte le 15 mars 2019

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)TypeScript (20 forks)github user discovery
enhancementgood first issuehelp wanted

Métriques du dépôt

Stars
 (129 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Examinez les fichiers TypeScript existants (lib/transaction.ts, lib/database.ts) et ajoutez des commentaires de documentation compatibles TSDoc à toutes les fonctions et méthodes publiques, en suivant les conventions utilisées ailleurs dans la base de code.
Stack technique
typescript
Domaine
apibackend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
TypeScript
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85