docs(assert): improve docs

[kt3k]

This PR improves the API docs of assert package. Now the @param @returns @typeParam are fully documented. It passes doc-linter check.

part of #4600 #3764

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.95%. Comparing base (1e194f7) to head (1d2faf4).
Report is 9 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4876      +/-   ##
==========================================
- Coverage   92.36%   91.95%   -0.41%     
==========================================
  Files         488      487       -1     
  Lines       41604    38895    -2709     
  Branches     5405     5388      -17     
==========================================
- Hits        38426    35765    -2661     
+ Misses       3122     3074      -48     
  Partials       56       56              

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

[iuioiua]

Instead of not evaluating the example code snippets, in most cases, we could instead remove LOC that throw and keep LOC that don't throw.

[iuioiua]

Sidenote: see #4891

[kt3k]

Instead of not evaluating the example code snippets, in most cases, we could instead remove LOC that throw and keep LOC that don't throw.

I think it's good to give explicit example of the case where it throws.

[iuioiua]

Nice!