Calibration documentation

[bdg221]

Since I have spending a lot of time with the Calibrator module, I started a list of things that should be addressed. While normally I would add these in my Notes app and then forget about them, I am trying to be a bit more responsible. I am hoping that we can discuss these and create issues out of them so that they can be addressed.

1. Currently, the docs on Calibration do not mention the the log parameter as part of the run method. I think this feature is very useful and should be highlighted in the docs.
   

2. Also, the values of log (flat and cartesian) are not included in the documentation (including the API-doc), let alone the difference between them.

3. The API-docs do include log_results_cartesian() and log_results_flat() though the example output is mangled and not a good representation. In the actual source code, the example output is perfect for both.
   
   

[bdg221]

The ZNE Calibration with Qiskit does use cal.run(log="flat", including some explanation about the results.

[natestemen]

Thanks a bunch for these Brian! Super useful feedback. In fact maybe the individual points should just be issues!? Would you mind opening some (as you see fit)? If you don't have time, I can too. Just let me know.

[bdg221]

Thanks, Nate. Now that things have calmed down I will go ahead and open up issues for each. I will also tackle them too, unless you want to leave them as good first time issues for newcomers.

[natestemen]

If you want to take em, please do!

[bdg221]

I have created the issues. I am cool if we want to close this discussion.

[natestemen]

Thank you Brian!