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.

Sign up for GitHub

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

Jump to bottom

Add a CI step to ensure 100% doc coverage #824

Open
omaralbeik opened this issue Apr 10, 2020 · 1 comment
Open

Add a CI step to ensure 100% doc coverage #824

omaralbeik opened this issue Apr 10, 2020 · 1 comment
Labels
CI CI and Github Actions related documentation good first issue help wanted

Comments

@omaralbeik
Copy link
Member

While generating docs for the v5.2, I noticed our doc coverage dropped to 99% due to a forgotten doc here. and was wondering if it is a good idea to add a CI step to make sure any newly introduced code is properly documented
@stavares843
Copy link
Member

hello! 👋

whats the command used to generate the coverage? when using jazzy coverage, the output is this which seems incorrect

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
CI CI and Github Actions related documentation good first issue help wanted
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@omaralbeik @stavares843