Fix SA1618 by documenting typeparams

[iamdmitrij]

Pull Request

The issue or feature being addressed

#1290

Details on the issue fix or feature implementation

• Added typeparam description to missing files
• Disabled warning suppression
• Fixed minor spelling mistakes

Confirm the following

• I started this PR by branching from the head of the default branch
• I have targeted the PR to merge into the default branch
• I have included unit tests for the issue/feature
• I have successfully run a local build

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 83.69%. Comparing base (c97c364) to head (fb9510a).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2078   +/-   ##
=======================================
  Coverage   83.69%   83.69%           
=======================================
  Files         312      312           
  Lines        7114     7114           
  Branches     1054     1054           
=======================================
  Hits         5954     5954           
  Misses        789      789           
  Partials      371      371           

Flag	Coverage Δ
linux	83.69% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[iamdmitrij]

@martincostello
there is an issue with macos-latest runners MacOS verions. Before my PR macos-latest resolved to MacOS v12:

Current runner version: '2.316.0'
Operating System
  macOS
  12.7.4
  21H1123

And since this PR it runs on MacOS v14:

Current runner version: '2.316.0'
Operating System
  macOS
  14.4.1
  23E224

when I reverted to macos-12 runner on my fork it started working (at least tests are passing): https://github.com/iamdmitrij/Polly/actions/runs/8843505291/job/24283830978

Not sure why tests on MacOS 14 are failing. Logs don't tell much, except that it fails during testing. Maybe it's related to Apple's M1 CPU architecture, but I don't have M1 to test further.

An error occurred when executing task '__RunTests'.
Completed in 00:00:59.0813715

So what should we do here?

[martincostello]

Thanks for working out the version change is why it's failing.

This PR will have to wait until we can investigate and fix our CI for macOS 14.

[martincostello]

If you rebase once #2079 is merged, things should work again 👍

[martincostello]

If you rebase things should be fixed now.

[iamdmitrij]

Thanks! My fork is synced now.