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 ability to force-show certain undocumented types even with skip_undocumented #1187

Open
sindresorhus opened this issue May 7, 2020 · 2 comments

Comments

@sindresorhus
Copy link

I want to use skip_undocumented: true to skip undocumented types. However, I have a Swift enum with a large amount of casees and they don't really need to be documented as their name makes it clear enough. It would be nice to be able to use some kind of code comment to indicate that I don't want to exclude those undocumented enum cases (without having to add it to each case).

@johnfairh
Copy link
Collaborator

Depending on scale you may find it easier to turn off skip_undocumented and use :nodoc: to explicitly opt items out of documentation.

@sindresorhus
Copy link
Author

That's my current workaround, yes. But I now have a lot of those comments all over the place.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants