http-party/node-portfinder

Update documentation for `getPort`, `getPorts`, `getSocket`

Open

#170 ouverte le 12 mars 2025

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)JavaScript (101 forks)github user discovery
good first issue

Métriques du dépôt

Stars
 (899 stars)
Métriques de merge PR
 (Métriques PR en attente)

Description

Update documentation for getPort, getPorts, getSocket

Follow the idea for docs from https://caolan.github.io/async/v3/docs.html#concat

see #168 and #169 for context.

Remove the *Promise based docs and only document getPort, getPorts, getSocket

Great issue for new contributors. Feel free to make a pull request! Don't hesitate to ask if you need help or are confused.

Guide contributeur

Direction de recherche
Consultez la documentation existante pour les fonctions mentionnées et mettez la à jour en suivant le modèle utilisé dans la documentation de concat de la bibliothèque async. Assurez vous de supprimer toute documentation basée sur Promise.
Stack technique
javascript
Domaine
documentation
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.
Moins d'une heure
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85