jama5262 / jiffy

Jiffy is a Flutter (Android, IOS and Web) date time package for parsing, manipulating, querying and formatting dates
https://pub.dev/packages/jiffy
MIT License
576 stars 124 forks source link

[ISSUE-188] Add code documentation to Jiffy #189

Closed jama5262 closed 1 year ago

jama5262 commented 1 year ago

What does this PR do?

Add code documentation to Jiffy

Resolves #188

codecov-commenter commented 1 year ago

Codecov Report

Base: 96.16% // Head: 96.17% // Increases project coverage by +0.00% :tada:

Coverage data is based on head (bb44b8f) compared to base (cc88b2d). Patch coverage: 93.75% of modified lines in pull request are covered.

:mega: This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #189 +/- ## ======================================== Coverage 96.16% 96.17% ======================================== Files 34 34 Lines 1513 1515 +2 ======================================== + Hits 1455 1457 +2 Misses 58 58 ``` | [Impacted Files](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed) | Coverage Δ | | |---|---|---| | [lib/src/display.dart](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed#diff-bGliL3NyYy9kaXNwbGF5LmRhcnQ=) | `100.00% <ø> (ø)` | | | [lib/src/parser.dart](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed#diff-bGliL3NyYy9wYXJzZXIuZGFydA==) | `100.00% <ø> (ø)` | | | [lib/src/query.dart](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed#diff-bGliL3NyYy9xdWVyeS5kYXJ0) | `100.00% <ø> (ø)` | | | [lib/src/utils/jiffy\_exception.dart](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed#diff-bGliL3NyYy91dGlscy9qaWZmeV9leGNlcHRpb24uZGFydA==) | `100.00% <ø> (ø)` | | | [lib/src/jiffy.dart](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed#diff-bGliL3NyYy9qaWZmeS5kYXJ0) | `98.75% <93.33%> (+<0.01%)` | :arrow_up: | | [lib/src/default\_display.dart](https://codecov.io/gh/jama5262/jiffy/pull/189?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed#diff-bGliL3NyYy9kZWZhdWx0X2Rpc3BsYXkuZGFydA==) | `100.00% <100.00%> (ø)` | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=Jama+Mohamed)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.