Mathis/sharp
1
0
Fork 0
mirror of https://github.com/lovell/sharp.git synced 2025-12-19 07:15:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: improve colour vs color consistency

Browse Source 
API supports both, docs prefer colour
This commit is contained in:
Lovell Fuller
2024-09-06 13:40:34 +01:00
parent 807d9241bd
commit b249357732
9 changed files with 31 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
lib/colour.js
View File

@@ -39,9 +39,9 @@ function tint (tint) {
/**
* Convert to 8-bit greyscale; 256 shades of grey.
* This is a linear operation. If the input image is in a non-linear colour space such as sRGB, use `gamma()` with `greyscale()` for the best results.
* By default the output image will be web-friendly sRGB and contain three (identical) color channels.
* By default the output image will be web-friendly sRGB and contain three (identical) colour channels.
* This may be overridden by other sharp operations such as `toColourspace('b-w')`,
* which will produce an output image containing one color channel.
* which will produce an output image containing one colour channel.
* An alpha channel may be present, and will be unchanged by the operation.
*
* @example