CATcher-org / CATcher

CATcher is a software application used for peer-testing of software projects.
https://catcher-org.github.io/CATcher/
MIT License
71 stars 66 forks source link

Add documentation for CATcher's parser #1240

Closed luminousleek closed 2 months ago

luminousleek commented 5 months ago

Summary:

Fixes #1204

Changes Made:

Proposed Commit Message:

When CATcher's parsers were updated to use arcsecond, there was minimal
documentation within the codebase to explain how the parsers work. As
such, it was difficult to understand and maintain these parsers.

Let's add examples for each comment template and explain the parsers
that are more difficult to understand.
codecov-commenter commented 5 months ago

Codecov Report

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

Comparison is base (fe7be44) 53.89% compared to head (c694926) 53.85%.

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1240 +/- ## ========================================== - Coverage 53.89% 53.85% -0.04% ========================================== Files 102 102 Lines 2889 2889 Branches 535 535 ========================================== - Hits 1557 1556 -1 Misses 989 989 - Partials 343 344 +1 ```

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