Will comments include examples of usage and links to interactive demos?

iDGS commented 10 years ago

I know it's still "early," roadmap-wise, but, just for the record, I miss the extensive descriptions of appropriate usage and links to live demos on jsfiddle that were among the riches of "old" InuitCSS.

E.g., compare the leading comments in the code for NEW media object:

https://github.com/inuitcss/objects.media/blob/master/_objects.media.scss

/*------------------------------------*\
    #MEDIA
\*------------------------------------*/

/**
 * Place any image- and text-like content side-by-side, as per:
 * stubbornella.org/content/2010/06/25/the-media-object-saves-hundreds-of-lines-of-code
 */

vs OLD:

https://github.com/csswizardry/inuit.css/blob/master/objects/_media.scss

(with apologies for using { below, b/c I couldn't figure out how to escape the <'s)

/*------------------------------------*\
    $MEDIA
\*------------------------------------*/
/**
 * Place any image- and text-like content side-by-side, as per:
 * stubbornella.org/content/2010/06/25/the-media-object-saves-hundreds-of-lines-of-code
 * E.g.:
 *
   {div class=media}
       {img src=http://placekitten.com/200/300 alt="" class=media__img}
       {p class=media__body}Lorem ipsum dolor sit amet, consectetur adipisicing elit,
       sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.{/p}
  {/div}
 *
 * Demo: jsfiddle.net/inuitcss/cf4Qs
 *
 */

Such details were a large part of the awesomeness of the previous edition, and very helpful for smart-ifying noobs and dilettantes such as myself.

I suspect it's something you're planning to include later, thus I just wanted to applaud and +1 the idea here.