Skip to content

@access annotation should override privatePrefix #384

@davidkpiano

Description

@davidkpiano

Please feel free to mark as invalid if this is working as designed.

If I have a function/mixin prefixed with a "conventionally private" underscore (though it may or may not be private) and an @access annotation is provided, the explicit value of @access should take precedence over the privatePrefix (without needing to mess with a configuration file). See example:

/// Creates a list of elements split into groups the length of `$size`.
/// If `$collection` can't be split evenly, the final chunk will be the remaining
/// elements.
///
/// @access public
/// @group List
/// @param {List} $list The list to process.
/// @param {number} $size [1] - The length of each chunk.
/// @returns {List} Returns the new list containing chunks.

@function _chunk($args...) {
    // ...
}

The generated Sassdoc will manifest this as [private], despite the @access public annotation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions