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

Include doc comments #45

Closed
chavlji opened this issue Nov 15, 2020 · 2 comments
Closed

Include doc comments #45

chavlji opened this issue Nov 15, 2020 · 2 comments

Comments

@chavlji
Copy link

chavlji commented Nov 15, 2020

I find this plugin great for documentation purposes (used in Storybook pages).

Would it be possible to somehow add doc comments found in the preceding lines?

Eg:
Screenshot 2020-11-15 at 16 02 32

So object for this variable would also include {... comments: ['Color for emphasized texts']}
This would enable us to keep documentation together with code.

@maximedaoust
Copy link

Unrelated to your actual problem, but would you mind explaining how you use sass-extract with Storybook?

@jgranstrom
Copy link
Owner

Since we actually compile the sass source to extract variables I'm fairly sure comments are not preserved, and it would likely require traversing the source AST separately, which is not in scope.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants