chore(analysis_options.yaml): report warnings for missing documentation #163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #163 +/- ##
==========================================
+ Coverage 66.69% 66.74% +0.05%
==========================================
Files 77 77
Lines 2438 2436 -2
==========================================
Hits 1626 1626
+ Misses 812 810 -2 ☔ View full report in Codecov by Sentry. |
JKRhb
force-pushed
the
missings-docs-error
branch
from
11667d5 to
ffa2d39
Compare
JKRhb
force-pushed
the
missings-docs-error
branch
from
e7fee87 to
5b56ce2
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Since (almost) 100% of the public API members have documentation provided, this PR enforces the addition of new documentation a bit more strictly by reporting a warning instead of an info message if no doc comment should be provided.
This could even be changed to an error later if the API should become completely stable; however, as the development process is still ongoing, that step is probably a bit too much at the moment.