Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@variable documentation inconsistent #49

Closed
peschee opened this issue Jul 6, 2014 · 5 comments
Closed

@variable documentation inconsistent #49

peschee opened this issue Jul 6, 2014 · 5 comments

Comments

@peschee
Copy link

peschee commented Jul 6, 2014

Hi @hugogiraudel

Consider the following example:

/**
 * Description of my variable
 * ---
 * @datatype string
 */
$some-other-variable: "a" !default;

/**
 * Defines whether the lib should support legacy browsers (e.g. `IE 8`).
 * ---
 * @since 0.3.9
 * @todo Nothing. It's awesome.
 * @link https://github.com/HugoGiraudel/SassDoc SassDoc
 * @datatype Bool
 */
$legacy-support: true !global;

The first variable documentation does not render at all. The second variable is missing the description. Any ideas why the first variable is not included in the rendered doc?

@KittyGiraudel
Copy link
Member

Ouh, that looks nifty. Let me have a look.

@peschee
Copy link
Author

peschee commented Jul 6, 2014

!default seems to be the problem there

@KittyGiraudel
Copy link
Member

Which version are you using?

@peschee
Copy link
Author

peschee commented Jul 6, 2014

Latest stable I recon? "sassdoc": "^0.4.1"

Maybe its best to switch to a rc version?

@KittyGiraudel
Copy link
Member

Okay, variables were not documented like this in 0.4.1 (we were using @var). I suggest you move to 1.0.0rc.6 which is the latest (and almost stable) version. I will release rc.7 today, and I believe 1.0.0 will hit live in the next couple of days.

@peschee peschee changed the title @variable documentation inconsistent @variable documentation inconsistent Jul 6, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants