stylelint-sassdoc/src/rules/function-is-documented/README.md

stylelint plugin to check scss files for a valid sassdoc documentation Credits to https://github.com/anneangersbach

# function-is-documented

Checks if @function is preceeded by at least one SassDoc Comment.
> ** Ignores private and nested functions. **

## Example

```scss
/// Removes the unit of a numeric value
/// @param {Number} $number - Number to remove the unit from
/// @return {Number} - Unitless number
@function strip-unit($number) {
    @if type-of($number) == 'number' and not unitless($number) {
        @return $number / ($number * 0 + 1);
    }

    @return $number;
}
```