Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pydocstyle errors #199

Closed
purva-thakre opened this issue Oct 16, 2023 · 1 comment · Fixed by #200
Closed

pydocstyle errors #199

purva-thakre opened this issue Oct 16, 2023 · 1 comment · Fixed by #200
Assignees
Labels
bug Something isn't working devops
Milestone

Comments

@purva-thakre
Copy link
Collaborator

Errors raised in jobs run in Github actions. poetry run pydocstyle tests/ toqito/ || true

toqito/nonlocal_games/xor_game.py:177 in public method `quantum_value`:
        D206: Docstring should be indented with spaces, not tabs
toqito/nonlocal_games/xor_game.py:177 in public method `quantum_value`:
        D207: Docstring is under-indented
toqito/nonlocal_games/xor_game.py:245 in public method `classical_value`:
        D202: No blank lines allowed after function docstring (found 1)
toqito/channel_metrics/completely_bounded_trace_norm.py:11 in public function `completely_bounded_trace_norm`:
        D205: 1 blank line required between summary line and description (found 0)
toqito/matrix_ops/inner_product.py:1 at module level:
        D400: First line should end with a period (not 'n')
toqito/matrix_ops/inner_product.py:6 in public function `inner_product`:
        D[20](https://github.com/purva-thakre/toqito/actions/runs/6527284296/job/17721926644#step:7:21)2: No blank lines allowed after function docstring (found 1)
toqito/matrix_ops/outer_product.py:1 at module level:
        D400: First line should end with a period (not 'n')
toqito/matrix_ops/outer_product.py:6 in public function `outer_product`:
        D209: Multi-line docstring closing quotes should be on a separate line
toqito/state_opt/state_exclusion.py:102 in private function `_min_error_primal`:
        D401: First line should be in imperative mood; try rephrasing (found 'The')
toqito/state_opt/state_exclusion.py:1[29](https://github.com/purva-thakre/toqito/actions/runs/6527284296/job/17721926644#step:7:30) in private function `_min_error_dual`:
        D401: First line should be in imperative mood; try rephrasing (found 'The')
toqito/matrix_props/trace_norm.py:6 in public function `trace_norm`:
        D205: 1 blank line required between summary line and description (found 0)
toqito/matrix_props/trace_norm.py:6 in public function `trace_norm`:
        D400: First line should end with a period (not '_')
toqito/matrix_props/is_diagonally_dominant.py:8 in public function `is_diagonally_dominant`:
        D208: Docstring is over-indented
@purva-thakre purva-thakre self-assigned this Oct 16, 2023
@purva-thakre purva-thakre added devops bug Something isn't working labels Oct 16, 2023
@vprusso
Copy link
Owner

vprusso commented Oct 16, 2023

Not as daunting as the pylint capture you provided which is good, but still important all the same. Again, great cataloging. This will make it much easier to address!

@purva-thakre purva-thakre added this to the Release 1.0.7 milestone Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working devops
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants