Qix-/color

Docs don't give examples of all supported constructor arguments

Open

#181 创建于 2020年5月6日

在 GitHub 查看
 (1 评论) (2 反应) (0 负责人)JavaScript (4,637 star) (316 fork)batch import
documentationhelp wantedpr welcome

描述

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.

贡献者指南

技术栈
javascript
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
under 1 hour
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic JavaScriptfamiliarity with Color library
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90
研究方向
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.