Add log param to calibration guide

[bdg221]

Description

Fixes #2516
Fixes #2575

This PR adds information about the run() method's log param and also the log_results_flat() and log_results_cartesian() methods to the Calibration Guide.

Also, the run() method's docstring was update with information about the log parameter.

License

• I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

• I updated the documentation where relevant.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.72%. Comparing base (a629c05) to head (12f5ae6).
Report is 12 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #2568   +/-   ##
=======================================
  Coverage   98.72%   98.72%           
=======================================
  Files          92       92           
  Lines        4161     4168    +7     
=======================================
+ Hits         4108     4115    +7     
  Misses         53       53           

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

---

🚨 Try these New Features:

• Flaky Tests Detection - Detect and resolve failed and flaky tests

[natestemen]

Thanks for adding this! Very handy to have documented.

Can you also add a more thorough docstring for the Calibrator.run method as part of this?

[natestemen]

Thanks Brian! Just a few nits, but good to go once those are addressed.