Qiskit / qiskit / 23649434579

87%

main: 87%

Build Type

push

github

Committed by web-flow

Commit Message

Enable missing argument in docstring lint (#15721)

* Enable missing argument in docstring lint

In the recently merged #15603 we migrated from pylint to use
ruff. During the development of that PR the rule group "D" for rules
derived from pydocstyle was investigated but the full rule group was
overly pedantic and even with disabling the most egregious rules also
changed the docs for the worse (at least by autofixing many rules) so
that sphinx would not succesfully build after applying the fixes. So
during #15603 the changes for this rule group were reverted. However,
one of the useful rules from that group D417 which checks that all
arguments are documented. This rule found real issues in the
documentation and it is worthwhile to enable it. This commit enables the
rule in our ruff checks and fixes the issues associated with.

During this process ruff flagged one place in the `__call__` method
docstring for the `TwoQubitControlledUDecomposer` class has not
documented several arguments on the method. However, these arguments
are unused currently. It is apparently trying to match the `__call__`
signature of the other two qubit decomposers but is not using most of
the arguments. Most could be conceivably supported by
`TwoQubitControlledUDecomposer` and it's not clear why they were added.
But, for this PR I didn't want to look into adding the support as it was
out of scope. For the time being this PR suppresses the ruff rule and
adds a TODO comment to start using the unused arguments.

* Update filename docstring

* Revise wording on state visualization filename arg

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

15 existing lines in 2 files now uncovered.

104010 of 118887 relevant lines covered (87.49%)

998926.9 hits per line