http-party/node-portfinder

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

Open

#170 aberto em 12 de mar. de 2025

Ver no GitHub
 (1 comment) (0 reactions) (0 assignees)JavaScript (101 forks)github user discovery
good first issue

Métricas do repositório

Stars
 (899 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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.

Guia do colaborador

Direção de pesquisa
Revise a documentação existente para as funções mencionadas e atualize as seguindo o padrão usado na documentação de concat da biblioteca async. Certifique se de remover qualquer documentação baseada em Promise.
Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85