H405 violations: multi line docstring summary not separated with an empty line

Bug #1482773 reported by Dolph Mathews
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Identity (keystone)
Fix Released
Low
Steve Martinelli
keystoneauth
Fix Released
Low
Lin Hua Cheng
keystonemiddleware
Fix Released
Low
Lance Bragstad
python-keystoneclient
Fix Released
Low
Lin Hua Cheng

Bug Description

Keystone's tox.ini contains an "ignore" entry for H405. All violations of H405 should be fixed so that H405 can be removed from the ignore list.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone (master)

Fix proposed to branch: master
Review: https://review.openstack.org/210607

Changed in keystone:
assignee: nobody → Dolph Mathews (dolph)
status: Triaged → In Progress
Changed in keystone:
assignee: Dolph Mathews (dolph) → Steve Martinelli (stevemar)
Changed in keystone:
assignee: Steve Martinelli (stevemar) → Dolph Mathews (dolph)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Fix proposed to branch: master
Review: https://review.openstack.org/211023

Changed in keystone:
assignee: Dolph Mathews (dolph) → Dave Chen (wei-d-chen)
Dave Chen (wei-d-chen)
Changed in keystone:
assignee: Dave Chen (wei-d-chen) → Dolph Mathews (dolph)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/210607
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=bf1e9e3995b031b54589683984d517339062d6dd
Submitter: Jenkins
Branch: master

commit bf1e9e3995b031b54589683984d517339062d6dd
Author: Dolph Mathews <email address hidden>
Date: Fri Aug 7 21:21:18 2015 +0000

    Improve a few random docstrings (H405)

    This is primarily in support of H405, but I took the opportunity to
    clean up a few spelling and grammar issues along the way.

    Change-Id: If3e81caca46a2c3d1b76af58d67ba9f9a9172aff
    Partial-Bug: 1482773

Changed in keystone:
assignee: Dolph Mathews (dolph) → Dave Chen (wei-d-chen)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/211023
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=bc999e2a35281be9883617de7e3b51428b423f64
Submitter: Jenkins
Branch: master

commit bc999e2a35281be9883617de7e3b51428b423f64
Author: Dave Chen <email address hidden>
Date: Mon Aug 10 15:53:34 2015 +0800

    Improve a few random docstrings

    - For triple-quoted strings, always use double quote characters to be
    consistent with the docstring convention in PEP 257.
    - Multi line docstrings should start with a one line summary followed
    by an empty line

    Change-Id: I591cd69f0ec9e7caabf559de09df422911dab91b
    Partial-Bug: 1482773

Changed in keystonemiddleware:
importance: Undecided → Low
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystonemiddleware (master)

Fix proposed to branch: master
Review: https://review.openstack.org/238161

Changed in keystonemiddleware:
assignee: nobody → Lance Bragstad (lbragstad)
status: New → In Progress
Revision history for this message
Tom Cocozzello (tjcocozz-deactivatedaccount) wrote :

FYI

When the ignore is not defined the tox.ini the default flake8
error codes that will be ignored are E123/E133, E226 and E241/E242.

Here is the doc:
http://flake8.readthedocs.org/en/latest/config.html#default

Changed in keystoneauth:
assignee: nobody → shravya Gaddam (shravya-g90)
Changed in python-keystoneclient:
assignee: nobody → shravya Gaddam (shravya-g90)
Changed in keystoneauth:
assignee: shravya Gaddam (shravya-g90) → nobody
Changed in python-keystoneclient:
assignee: shravya Gaddam (shravya-g90) → nobody
Changed in keystoneauth:
assignee: nobody → Lin Hua Cheng (lin-hua-cheng)
Changed in python-keystoneclient:
assignee: nobody → Lin Hua Cheng (lin-hua-cheng)
Changed in keystoneauth:
importance: Undecided → Low
Changed in python-keystoneclient:
importance: Undecided → Low
Changed in keystonemiddleware:
assignee: Lance Bragstad (lbragstad) → Lin Hua Cheng (lin-hua-cheng)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystoneauth (master)

Fix proposed to branch: master
Review: https://review.openstack.org/243889

Changed in keystoneauth:
status: New → In Progress
Changed in keystonemiddleware:
assignee: Lin Hua Cheng (lin-hua-cheng) → Lance Bragstad (lbragstad)
Changed in keystonemiddleware:
assignee: Lance Bragstad (lbragstad) → Lin Hua Cheng (lin-hua-cheng)
Changed in keystonemiddleware:
assignee: Lin Hua Cheng (lin-hua-cheng) → Lance Bragstad (lbragstad)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystoneauth (master)

Reviewed: https://review.openstack.org/243889
Committed: https://git.openstack.org/cgit/openstack/keystoneauth/commit/?id=63429aeca8f2e88dc1ff1b8b1131386165d4018f
Submitter: Jenkins
Branch: master

commit 63429aeca8f2e88dc1ff1b8b1131386165d4018f
Author: lin-hua-cheng <email address hidden>
Date: Tue Nov 10 17:54:33 2015 -0800

    Address hacking check H405

    Previously, there were a string of commits to keystone that addresed ignored
    hacking checks. This commit does the same for H405 in keystoneauth. This
    also modifies our tox.ini so that we no longer ignore H405 violations.

    Change-Id: I0ac1165f309edd486639e2729c18330b1d062eb3
    Closes-Bug: 1482773

Changed in keystoneauth:
status: In Progress → Fix Committed
Revision history for this message
Lin Hua Cheng (lin-hua-cheng) wrote :
Changed in python-keystoneclient:
status: New → Triaged
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystonemiddleware (master)

Reviewed: https://review.openstack.org/238161
Committed: https://git.openstack.org/cgit/openstack/keystonemiddleware/commit/?id=01297dce1a24d8506093f3a8c89c4e7484e9402c
Submitter: Jenkins
Branch: master

commit 01297dce1a24d8506093f3a8c89c4e7484e9402c
Author: Lance Bragstad <email address hidden>
Date: Wed Oct 21 16:37:58 2015 +0000

    Address hacking check H405.

    Previously, there were a string of commits to keystone that addresed ignored
    hacking checks. This commit does the same for H405 in keystonemiddleware. This
    also modifies our tox.ini so that we no longer ignore H405 violations.

    This is a non-functional change.

    Change-Id: I7bbe99719feb39e96634c903991294c18c33112b
    Closes-Bug: 1482773

Changed in keystonemiddleware:
status: In Progress → Fix Committed
Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/keystoneauth 2.0.0

This issue was fixed in openstack/keystoneauth 2.0.0 release.

Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/keystonemiddleware 4.0.0

This issue was fixed in openstack/keystonemiddleware 4.0.0 release.

Changed in keystoneauth:
milestone: none → 2.1.0
status: Fix Committed → Fix Released
Changed in keystonemiddleware:
status: Fix Committed → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to python-keystoneclient (master)

Fix proposed to branch: master
Review: https://review.openstack.org/267172

Changed in python-keystoneclient:
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to python-keystoneclient (master)

Reviewed: https://review.openstack.org/267172
Committed: https://git.openstack.org/cgit/openstack/python-keystoneclient/commit/?id=77ed0d4d0c3413b15aa348613b8b40373bd5765b
Submitter: Jenkins
Branch: master

commit 77ed0d4d0c3413b15aa348613b8b40373bd5765b
Author: lin-hua-cheng <email address hidden>
Date: Wed Jan 13 13:03:51 2016 -0800

    Address hacking check H405

    Previously, there were a string of commits to keystone that addresed ignored
    hacking checks. This commit does the same for H405 in keystoneclient. This
    also modifies our tox.ini so that we no longer ignore H405 violations.

    Change-Id: I2af152e5425a0e9c82314039fdbb90d661c22680
    Closes-Bug: 1482773

Changed in python-keystoneclient:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to keystone (master)

Fix proposed to branch: master
Review: https://review.openstack.org/278190

Tin Lam (lamt)
Changed in keystone:
assignee: Dave Chen (wei-d-chen) → Tin Lam (tinlam)
Changed in keystone:
assignee: Tin Lam (tinlam) → Tin Lam (tl3438)
Revision history for this message
Doug Hellmann (doug-hellmann) wrote : Fix included in openstack/python-keystoneclient 2.2.0

This issue was fixed in the openstack/python-keystoneclient 2.2.0 release.

Changed in keystone:
milestone: none → mitaka-3
Changed in keystone:
assignee: Tin Lam (tl3438) → Steve Martinelli (stevemar)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to keystone (master)

Reviewed: https://review.openstack.org/278190
Committed: https://git.openstack.org/cgit/openstack/keystone/commit/?id=2bad130bf457ab4b23b65f9b407a8cc8bde300fe
Submitter: Jenkins
Branch: master

commit 2bad130bf457ab4b23b65f9b407a8cc8bde300fe
Author: Tin Lam <email address hidden>
Date: Tue Feb 9 20:18:35 2016 -0600

    Removing H405 violations from keystone

    Keystone's tox.ini contains an "ignore" entry for H405 violations:
    multi line docstring summary not separated with an empty line.
    All violations of H405 should be fixed so that H405 can be removed
    from the ignore list.

    Change-Id: I1b2aae0cabc20909cf3b0a405d5e31c5d91148b2
    Closes-Bug: #1482773

Changed in keystone:
status: In Progress → Fix Released
Revision history for this message
Thierry Carrez (ttx) wrote : Fix included in openstack/keystone 9.0.0.0b3

This issue was fixed in the openstack/keystone 9.0.0.0b3 development milestone.

Changed in cinder:
assignee: nobody → hongzhezheng (zheng-hongzhe32)
no longer affects: cinder
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.