From bd7f5d7b8cb151ba889857e4efd50399c0224ecf Mon Sep 17 00:00:00 2001 From: koki-higashikawa Date: Tue, 7 Feb 2017 12:56:07 +0900 Subject: [PATCH] Modify doc comment. --- scss/util/_color.scss | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/scss/util/_color.scss b/scss/util/_color.scss index a7e4aa339..73990a867 100644 --- a/scss/util/_color.scss +++ b/scss/util/_color.scss @@ -55,10 +55,11 @@ /// Checks the luminance of `$base`, and returns the color from `$colors` (list of colors) that has the most contrast. /// -/// @param {Color} $color1 - First color to compare. -/// @param {Color} $color2 - Second color to compare. +/// @param {Color} $base - Color to check luminance. +/// @param {List} $colors - Colors to compare. +/// @param {Number} $tolerance [$global-color-pick-contrast-tolerance] - Contrast tolerance. /// -/// @returns {Number} The contrast ratio of the compared colors. +/// @returns {Color} the color from `$colors` (list of colors) that has the most contrast. @function color-pick-contrast($base, $colors: ($white, $black), $tolerance: $global-color-pick-contrast-tolerance) { $contrast: color-contrast($base, nth($colors, 1)); $best: nth($colors, 1); -- 2.47.2