http-party/node-portfinder

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

Open

#170 aperta il 12 mar 2025

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)JavaScript (101 fork)github user discovery
good first issue

Metriche repository

Star
 (899 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Rivedi la documentazione esistente per le funzioni menzionate e aggiornala seguendo il modello utilizzato nella documentazione di concat della libreria async. Assicurati di rimuovere qualsiasi documentazione basata su Promise.
Tech stack
javascript
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85