search

SassDoc / sassdoc

Release the docs!
http://sassdoc.com
MIT License
1.41k stars 56 forks source link

How to document vendor code? #459

Closed bendman closed 7 years ago

bendman commented 8 years ago

Is it possible to document vendor SCSS, and if so, how?

For example, if you use Bourbon or Susy in your Sass, how would document mixins provided by the vendor library, without adding comments to the vendor library itself?

Is there some way to add doc comments that are associated with an import, or aren't associated with any code?

KittyGiraudel commented 8 years ago

Hey there.

As of today, there is no way to do that. I’m sorry. :(

pascalduez commented 8 years ago

Hi,

Sounds a little bit weird isn't it? I would say it's not the responsibility of a given code to document its third party dependencies.
On the other hand one can always leverage the @require annotation to explicitly define them.

bendman commented 8 years ago

@HugoGiraudel No worries, we'll figure something out!

@pascalduez Yeah, I think it's not really the responsibility of a styleguide to document third party tools like that, but it's an unfortunate reality if the tools don't have great docs, you have a particular way of using the tool, or you want documentation all in one place.

If we find a workaround we'll post it in here for others that might share our concerns though!

KittyGiraudel commented 7 years ago

I’m going to close this. :)