mozilla / rust-code-analysis

Library to analyze and collect metrics on source code
https://mozilla.github.io/rust-code-analysis/
262 stars 46 forks source link

Document library functions #1051

Open Luni-4 opened 1 year ago

Luni-4 commented 1 year ago

This PR documents public library functions

codecov-commenter commented 1 year ago

Codecov Report

Patch coverage has no change and project coverage change: +0.10 :tada:

Comparison is base (0f93821) 74.06% compared to head (fabc5de) 74.17%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1051 +/- ## ========================================== + Coverage 74.06% 74.17% +0.10% ========================================== Files 64 64 Lines 16033 16023 -10 ========================================== + Hits 11875 11885 +10 + Misses 4158 4138 -20 ``` | [Impacted Files](https://app.codecov.io/gh/mozilla/rust-code-analysis/pull/1051?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla) | Coverage Δ | | |---|---|---| | [src/alterator.rs](https://app.codecov.io/gh/mozilla/rust-code-analysis/pull/1051?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla#diff-c3JjL2FsdGVyYXRvci5ycw==) | `49.31% <ø> (ø)` | | | [src/lib.rs](https://app.codecov.io/gh/mozilla/rust-code-analysis/pull/1051?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla#diff-c3JjL2xpYi5ycw==) | `100.00% <ø> (ø)` | | | [src/macros.rs](https://app.codecov.io/gh/mozilla/rust-code-analysis/pull/1051?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla#diff-c3JjL21hY3Jvcy5ycw==) | `77.35% <ø> (+7.54%)` | :arrow_up: | ... and [5 files with indirect coverage changes](https://app.codecov.io/gh/mozilla/rust-code-analysis/pull/1051/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=mozilla)

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