@requires bug with mixins about sassdoc HOT 6 CLOSED

I am not sure what's the best way to tackle this one.

Could @requires need a type argument (mixin/function/variable)?

// @requires {mixin} base
// @requires {function} thing
// @requires {var} some-global-variable 

Any input, @valeriangalliat?

from sassdoc.

I'm not sure - I mean, on one hand - its probably not a good idea to have mixins and functions sharing names in your code base, but as a documentation tool - I'm not sure if its valid to be opinionated about best practices - so maybe the type argument would be optional @hugogiraudel ?

My comment assumes, @danielguillan, that what you're having an issue with is that in addition to the Sass you posted in your comment, you also have a function named base?

Eg.

@mixin base {
    @content;
}

@function base() {
    @return foo;
}

// Requires base
// ---
// @requires base
@mixin requires-base {
    @content;
}

Is this a complete demonstration of what our Sass contains that is causing the bug?

from sassdoc.

I was about to say the exact same thing as @alademann - make the type optional, and add a warning when there is no type and a name conflict between a function/mixin/var.

from sassdoc.

My comment assumes, @danielguillan, that what you're having an issue with is that in addition to the Sass you posted in your comment, you also have a function named base?

Nope, as of today, if you use @requires on a mixin, it will try to fetch a function, and vice versa. Not sure why it works this way though.

from sassdoc.

Agreed on having optional type.

from sassdoc.

Okay, it should now be fixed in both master and real-parser branches.

Basically the idea is the following one: when parsing a @requires flag, if there is a type given, we store it. Then once we're done parsing everything, the same way we deal with aliases, we post treat data to fill missing informations.

In this case, for each item with at least a require, and in the case where the type has not been given obviously, we find the type of the first item named after the value of the require flag, and store it.

from sassdoc.