Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for functions to be part of multiple categories #175

Closed
theryansmee opened this issue Feb 9, 2022 · 0 comments · Fixed by #176
Closed

Add support for functions to be part of multiple categories #175

theryansmee opened this issue Feb 9, 2022 · 0 comments · Fixed by #176
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@theryansmee
Copy link
Collaborator

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

@theryansmee theryansmee self-assigned this Feb 9, 2022
@theryansmee theryansmee added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 9, 2022
theryansmee added a commit that referenced this issue Feb 9, 2022
Add multi category logic. Update functions with to have multiple
categories

✅ Closes: #175
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant