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.

Sign up for GitHub

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

Jump to bottom

Consider using SassDoc #6

Closed
KittyGiraudel opened this issue Dec 31, 2014 · 6 comments
Closed

Consider using SassDoc #6

KittyGiraudel opened this issue Dec 31, 2014 · 6 comments
Assignees
@eduardoboucas

Comments

@KittyGiraudel
Copy link
Collaborator

For documentation. :)
@eduardoboucas
Copy link
Owner

Do you think it makes sense for something this size? The only public feature is the mixin. Would you also include "private" functions/helpers?

@KittyGiraudel
Copy link
Collaborator Author

Depends on what you expect from users. If they can build upon your lib, then document everything. :)

@eduardoboucas eduardoboucas self-assigned this Jan 8, 2015
@eduardoboucas
Copy link
Owner

Done! SassDoc here.

@KittyGiraudel
Copy link
Collaborator Author

Why isn't the config documented?

@eduardoboucas
Copy link
Owner

eduardoboucas commented Jan 19, 2015 •
edited by KittyGiraudel
Loading

Good point. I'll have another look at SassDoc to see what are the best annotations to document maps.

I've reopened this. Cheers Kitty!

@eduardoboucas eduardoboucas reopened this Jan 19, 2015
@eduardoboucas
Copy link
Owner

Fixed in #22 and #23.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eduardoboucas eduardoboucas

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@KittyGiraudel @eduardoboucas