Closed NoureldinYosri closed 7 months ago
gpylint run with the new configuration found following docstring issues.
I think it is worthwhile to fix them so we have a complete info from pydoc or if this gets rendered in web docs, WDYT?
************* File cirq-core/cirq/experiments/two_qubit_xeb.py
cirq-core/cirq/experiments/two_qubit_xeb.py:1:0: missing-module-docstring
cirq-core/cirq/experiments/two_qubit_xeb.py:71:0: g-doc-return-or-yield
cirq-core/cirq/experiments/two_qubit_xeb.py:99:0: g-doc-return-or-yield
cirq-core/cirq/experiments/two_qubit_xeb.py:149:0: g-short-docstring-punctuation
cirq-core/cirq/experiments/two_qubit_xeb.py:149:0: g-doc-return-or-yield
cirq-core/cirq/experiments/two_qubit_xeb.py:242:0: g-doc-return-or-yield
cirq-core/cirq/experiments/two_qubit_xeb.py:271:0: g-doc-args
cirq-core/cirq/experiments/two_qubit_xeb.py:272:0: g-doc-return-or-yield
@pavoljuhas I completed the missing docstrings with the help of an LLM :D. ptal
@pavoljuhas I completed the missing docstrings with the help of an LLM :D. ptal
Looks good! :-o
There is one last thing about changing the default value of the random_state
argument to None, otherwise LGTM.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Additional details and impacted files
```diff @@ Coverage Diff @@ ## main #6471 +/- ## ========================================== - Coverage 97.75% 97.75% -0.01% ========================================== Files 1105 1105 Lines 94897 94909 +12 ========================================== + Hits 92771 92782 +11 - Misses 2126 2127 +1 ```:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.