ngneat/falso

JSdoc description of function should include a few examples of result

Opened this issue · 1 comments

czlowiek488 commented

Description

JSdoc should include result examples for each example.
This would make finding correct method easier.

It could be fancy to fill examples automatically on some npm hook.
If we agree to solution I may implement it.

Proposed solution

/**
 * Generate a random credit card brand.
 *
 * @category Finance
 *
 * @example
 *
 * randCreditCardBrand()
 * 
 * "Visa"
 * "Visa Electron"
 * "UATP"
 */

image

Alternatives considered

No response

Do you want to create a pull request?

Yes

NetanelBasal commented

You're welcome to submit a PR. You can start with POC that shows one example.