Qix-/color

Docs don't give examples of all supported constructor arguments

Open

#181 aberto em 6 de mai. de 2020

Ver no GitHub
 (1 comment) (2 reactions) (0 assignees)JavaScript (4.637 stars) (316 forks)batch import
documentationhelp wantedpr welcome

Description

The docs give examples of various forms of Color.rgb() with 3 arguments, but never give an example of specifying an alpha value in the constructor. They do give the example Color('#7743CE').alpha(0.5) but nothing like Color.rgb([0x77, 0x43, 0xCE, 0.5]).

Also, there are no examples of construction from non-RGB color spaces. Color.hsl(200,80,70) works but is never mentioned.

Guia do colaborador

Pilha de tecnologia
javascript
Domain
documentation
Tipo Issue
documentation
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
stale
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
basic JavaScriptfamiliarity with Color library
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90
Direção de pesquisa
Add documentation examples for Color.rgb() with alpha and Color.hsl() usage. Look at the main documentation file (likely README.md or docs/) and insert examples after existing rgb() examples. The issue mentions no example of Color.rgb([0x77, 0x43, 0xCE, 0.5]) and no mention of Color.hsl(200,80,70). Ensure the new examples are consistent with existing style.