search

jauco / jester

Get your project tested and out there with minimal fuss.
https://trello.com/b/GLFKT2X4/jester
BSD 3-Clause "New" or "Revised" License
3 stars 3 forks source link

Jsdoc #9

Closed barbarah closed 10 years ago

barbarah commented 10 years ago

Updated jsdoc to 3.3.0-alpha8

jauco commented 10 years ago

Dus het is kapot gegaan tussen alpha8 en alpha9? Wellicht is dan makkelijk te zien welke commit hem kapot maakte? En waarom de jsdoc developers dat nuttig vonden?

(Want ik vind het een beetje eng als we nu jsdoc nooit meer boven versie alpha8 mogen ophogen)

barbarah commented 10 years ago

Ja, zie opmerking van Lutger in Trello:

JSDoc vind /** */ inderdaad niet meer goed. Dit lijkt de bedoeling geweest te zijn en ik zie ook nog geen manier om dit te omzeilen. Maar misschien komt het niet in de uiteindelijke release terecht. Zie deze commit: https://github.com/jsdoc3/jsdoc/commit/eeb9c94c66405507a215361de0dffb162bc9e41c

Voorlopig zouden we op 3.3.0-alpha8 kunnen gaan zitten, die vereist geen administrator rechten en staat /** */ nog steeds toe.

jauco commented 10 years ago

Ok. Ik wilde de volgende opmerking op die ticket plaatsen:

Hey, if I understand this correctly empty tags (/** */) are now no longer allowed. We use jsdoc to generate documentation for our commonJS javascript codebase, and for many modules the name is descriptive enough not to warrant extra documentation. Currently we mark these for inclusion in the docs with /** */ Is there a better way to mark them for inclusion? Retyping the functionName doesn't sound very DRY to me.

Maar ik weet niet zeker of ik het probleem goed verwoord. Kan een van jullie een soortgelijk opmerking (maar dan wel factueel juist) op de ticket plaatsen zodat de kans dat ze dit terug draaien / ons een andere oplossing bieden wat groter is?

groetjes, Jauco

2014-07-01 17:27 GMT+02:00 Barbara notifications@github.com:

Ja, zie opmerking Lutger in Trello:

JSDoc vind /* / inderdaad niet meer goed. Dit lijkt de bedoeling geweest te zijn en ik zie ook nog geen manier om dit te omzeilen. Maar misschien komt het niet in de uiteindelijke release terecht. Zie deze commit: jsdoc3/jsdoc@eeb9c94 https://github.com/jsdoc3/jsdoc/commit/eeb9c94c66405507a215361de0dffb162bc9e41c

Voorlopig zouden we op 3.3.0-alpha8 kunnen gaan zitten, die vereist geen administrator rechten en staat /* / nog steeds toe.

— Reply to this email directly or view it on GitHub https://github.com/jauco/jester/pull/9#issuecomment-47670571.