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 documentation for CATcher's parser #1240

Merged
merged 3 commits into from
Apr 26, 2024

Conversation

luminousleek
Copy link
Contributor

Summary:

Fixes #1204

Changes Made:

  • Add comment formats and examples
  • Add examples for parsers that are more difficult to understand

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
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

Additional details and impacted files
@@            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     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@cheehongw cheehongw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@cheehongw cheehongw merged commit c7461b2 into CATcher-org:master Apr 26, 2024
4 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for CATcher's parser
3 participants