jshwi / docsig

Check signature params for proper documentation
https://docsig.readthedocs.io
MIT License
36 stars 2 forks source link

description missing and description syntax error #461 #462

Closed jshwi closed 2 months ago

jshwi commented 2 months ago

If one arg was missing, and another description spanned over multiple lines, this would result in a description syntax error (which is not valid for either), and not just the one description missing violation

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (3b5f65b) to head (3312335). Report is 4 commits behind head on master.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #462 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 24 24 Lines 4112 4091 -21 ========================================= - Hits 4112 4091 -21 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.