Skip to content

Update README with complete documentation#48

Merged
mmucklo merged 1 commit intomasterfrom
comments
Feb 8, 2026
Merged

Update README with complete documentation#48
mmucklo merged 1 commit intomasterfrom
comments

Conversation

@mmucklo
Copy link
Owner

@mmucklo mmucklo commented Feb 8, 2026

  • Add LengthLimits configuration section with examples
  • Document comment extraction feature with examples
  • Update ParseOptions constructor signature
  • Add comments field to all return value examples
  • Include simple_address and other missing fields
  • Document default RFC length limits
  • Add examples for createDefault() and createRelaxed() factory methods
  • Make README comprehensive yet easy to understand

- Add LengthLimits configuration section with examples
- Document comment extraction feature with examples
- Update ParseOptions constructor signature
- Add comments field to all return value examples
- Include simple_address and other missing fields
- Document default RFC length limits
- Add examples for createDefault() and createRelaxed() factory methods
- Make README comprehensive yet easy to understand
@codecov
Copy link

codecov bot commented Feb 8, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.02%. Comparing base (c479cc4) to head (7b0d41e).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##             master      #48   +/-   ##
=========================================
  Coverage     77.02%   77.02%           
  Complexity      219      219           
=========================================
  Files             3        3           
  Lines           505      505           
=========================================
  Hits            389      389           
  Misses          116      116           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@mmucklo mmucklo merged commit 4ea8f3f into master Feb 8, 2026
9 of 10 checks passed
@mmucklo mmucklo deleted the comments branch February 8, 2026 04:21
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.

1 participant