Add yardoc documentation to client.rb

[ellnix]

Pull Request

This contains preliminary work on #596 to address the lack of anything more than surface-level documentation on this gem.

Related issue

Fixes #596

How to view documentation

1. gem install yardoc
2. yardoc doc
3. yardoc server
4. Visit localhost:8808

With live updates:
requires entr

• In terminal 1: ls lib/**/*.rb | entr -c yardoc doc
• In terminal 2: yard server -r

Steps

• Wait for input on yardoc documentation #596
• Write documentation for other files
• Add documentation check to Github actions
• Publish documentation

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (6ffc322) to head (02418e2).
Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #602   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines          804       804           
=========================================
  Hits           804       804           

☔ 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.

[ellnix]

Had to deal with rubocop again @brunoocasali

[brunoocasali]

bors merge

[meili-bors]

Build succeeded:

• integration-tests (ruby 3.3)
• integration-tests (ruby 3.1)
• linter-check
• integration-tests (ruby 3.2)