search

holidaypirates / nucleus

Nucleus is a living style guide generator for atomic css based components. It's a Node application parsing the source SCSS files and reading information from DocBlock annotations.
https://holidaypirates.github.io/nucleus/
MIT License
474 stars 43 forks source link

Question : Annotation Reference and "*" #14

Open paallaire opened 8 years ago

paallaire commented 8 years ago

Do you think is possible don't have the "*" in the "Annotation Reference" ?

Right now

/**
 * @atom Button
 * @section Navigation > Buttons
 * @markup
 *   <button class="button">
 *     A button
 *   </button>
 *   <button class="button button--alert">
 *     An alert button
 *   </button>
 */

Suggestion

 /**
 @atom Button
 @section Navigation > Buttons
 @markup
  <button class="button">A button</button>
  <button class="button button--alert"> An alert button</button>
 */
michaelseibt commented 8 years ago

Mh, would make it hard to scan for relevant multiline comment blocks then, since we would not be able to differentiate between DocBlock and normal "content" comment anymore.

What's your concern about the *s ?

paallaire commented 8 years ago

I find annoy to update the @markup with "*".

I think it will be better if only you need to copy & paste the code without add the "*" after.

 /**
 * @atom Button
 * @section Navigation > Buttons
 * @markup
  <button class="button">A button</button>
  <button class="button button--alert"> An alert button</button>
 */
shealan commented 8 years ago

That actually does seem a little easier on the eye. Would also mean devs can copy the example without having to remove the * before use.

michaelseibt commented 8 years ago

I will consider both your suggestions, thanks for that! As soon as TravisCI is properly set up, we can explore this a bit more.