ngneat/falso

Add support for functions to be part of multiple categories

Closed this issue · 0 comments

Description

Discussed in #173

Originally posted by theryansmee February 9, 2022
It might be cool to be able to add multiple categories to a function so that it appears in multiple places in the documentation.
For example, a user would probably expect randSuperHero to appear in the "Comic book" and the "Entity" part of the docs

Proposed solution

Allow comma separated categories e.g

/**
 * Generate a random address.
 *
 * @category entities, address
 *
 * @example
 *
 * randAddress()
 *
 * @example
 *
 * randAddress({ length: 10 })
 *
 */

Alternatives considered

No response

Do you want to create a pull request?

Yes