mrjono1 / joi-to-typescript

Convert Joi Schemas to TypeScript interfaces
MIT License
124 stars 39 forks source link

Add a spacing between JsDoc description and any additional examples #406

Closed cmaster11 closed 7 months ago

cmaster11 commented 7 months ago

I feel comments become more readable with spacing 🤔

/**
 * A simple description
 * @example
 * {
 *   "hello": "world"
 * }
 * @example
 * {
 *   "hello": "world2"
 * }
 */
export interface HelloTest {
  hello?: string;
}

vs

/**
 * A simple description
 * 
 * @example
 * {
 *   "hello": "world"
 * }
 * @example
 * {
 *   "hello": "world2"
 * }
 */
export interface HelloTest {
  hello?: string;
}
codecov[bot] commented 7 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Comparison is base (dcd081d) 98.74% compared to head (1f1b7b7) 98.75%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #406 +/- ## ======================================= Coverage 98.74% 98.75% ======================================= Files 9 9 Lines 557 560 +3 Branches 214 215 +1 ======================================= + Hits 550 553 +3 Misses 7 7 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.