neutron

Doc-string Formatting Clean-up (pep 257)

Bug #1020184 reported by dan wendlandt
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
Wishlist
Sergey Skripnick
neutron 2013.2 "havana"

Bug Description

Many files in the code-base lack doc-strings, or have improperly formatted doc-strings according to the conventions described in pep-257 (http://www.python.org/dev/peps/pep-0257/).

Would be nice to have these cleaned up.

Likely the best approach is to split up this work into smaller change-sets by doing related chunks of files at the same time (e.g., quantum/db/*.py). This makes reviewing easier as well.

dan wendlandt (danwent)
tags: added: low-hanging-fruit
Changed in quantum:
importance: Undecided → Wishlist
Shifu Miao (sfmiao)
security vulnerability: no → yes
Revision history for this message
dan wendlandt (danwent) wrote :

why would this be considered a security vulnerability? This is about internal code documentation.

security vulnerability: yes → no
Revision history for this message
Harsh Prasad (prasad-tanay) wrote :

Do you want each defs to have a doc-string or you want to clean up the existing doc-strings?

Revision history for this message
Harsh Prasad (prasad-tanay) wrote :

Existing doc strings can be cleaned up according to pep257 easily. But if new doc strings are also to be added then please do tell.

dk647 (meizu647)
Changed in quantum:
assignee: nobody → dk647 (meizu647)
dk647 (meizu647)
Changed in quantum:
assignee: dk647 (meizu647) → nobody
Thierry Carrez (ttx)
Changed in quantum:
status: New → Confirmed
Numero 8 (numero-8)
Changed in quantum:
assignee: nobody → Numero 8 (numero-8)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to quantum (master)

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

Changed in quantum:
assignee: Numero 8 (numero-8) → eyerediskin (eyerediskin)
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Reviewed: https://review.openstack.org/27538
Committed: http://github.com/openstack/quantum/commit/85ffc01eee00dab0a076ee367dbe04b131653423
Submitter: Jenkins
Branch: master

commit 85ffc01eee00dab0a076ee367dbe04b131653423
Author: Sergey Skripnick <email address hidden>
Date: Fri Apr 26 11:41:38 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/agent/*
    quantum/api/*

    Change-Id: I206206b66b4adf5cda73a6bb709a0935d7efa821

Changed in quantum:
status: In Progress → Fix Committed
Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/27539
Committed: http://github.com/openstack/quantum/commit/b28dc107a90afc5d718473e9b289847cab6e809b
Submitter: Jenkins
Branch: master

commit b28dc107a90afc5d718473e9b289847cab6e809b
Author: Sergey Skripnick <email address hidden>
Date: Fri Apr 26 12:03:12 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/common/*
    quantum/db/*
    quantum/debug/*
    quantum/extensions/*

    Change-Id: I8fdf72ae1702ef2a2652a1db683d8b31e09e6f84

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

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

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

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

Reviewed: https://review.openstack.org/27812
Committed: http://github.com/openstack/quantum/commit/13fbf22ff43512936eff8733457b69546fd4c70d
Submitter: Jenkins
Branch: master

commit 13fbf22ff43512936eff8733457b69546fd4c70d
Author: Sergey Skripnick <email address hidden>
Date: Tue Apr 30 16:52:33 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/tests/*

    Change-Id: I5c31a70e80c7fd448b92b43d34341301533b59ba

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/27798
Committed: http://github.com/openstack/quantum/commit/ee3bb94b247e79bcf0b735acb9341a89e289943c
Submitter: Jenkins
Branch: master

commit ee3bb94b247e79bcf0b735acb9341a89e289943c
Author: Sergey Skripnick <email address hidden>
Date: Tue Apr 30 10:47:43 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/plugins/cisco/*

    Change-Id: Ibb6a865a17de0ea4f1865972624e4c5da0e96b34

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/27804
Committed: http://github.com/openstack/quantum/commit/ad3b6064dff135dd34d997167ec2ef628828d95e
Submitter: Jenkins
Branch: master

commit ad3b6064dff135dd34d997167ec2ef628828d95e
Author: Sergey Skripnick <email address hidden>
Date: Tue Apr 30 13:35:37 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/plugins/hyperv/*
    quantum/plugins/linuxbridge/*
    quantum/plugins/nec/*
    quantum/plugins/nicira/*
    quantum/plugins/plumgrid/*
    quantum/plugins/ryu/*
    quantum/plugins/services/*

    Change-Id: I3525aa57235935d90ec7b70c65ba15012ce575a3

Revision history for this message
OpenStack Infra (hudson-openstack) wrote :

Reviewed: https://review.openstack.org/27712
Committed: http://github.com/openstack/quantum/commit/1e166f3efd72459fabe83e2141461329c67c811a
Submitter: Jenkins
Branch: master

commit 1e166f3efd72459fabe83e2141461329c67c811a
Author: Sergey Skripnick <email address hidden>
Date: Mon Apr 29 16:46:51 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/plugins/bigswitch/*
    quantum/plugins/brocade/*

    Change-Id: I9bf4381738319551a5993d4b279a5cec3425b7ef

Mark McClain (markmcclain)
Changed in quantum:
milestone: none → havana-1
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to quantum (master)

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

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

Reviewed: https://review.openstack.org/29207
Committed: http://github.com/openstack/quantum/commit/ecc0e7a9de9b0384c485b2dff60ef3acfa371fdc
Submitter: Jenkins
Branch: master

commit ecc0e7a9de9b0384c485b2dff60ef3acfa371fdc
Author: Sergey Skripnick <email address hidden>
Date: Wed May 15 10:48:33 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    quantum/*

    Change-Id: I771e0f0d6121b7c03cecd82583e9a6c1915f891d

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

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

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

Reviewed: https://review.openstack.org/29565
Committed: http://github.com/openstack/quantum/commit/933259f67520d092d4a29d5287d823f3b08e44c3
Submitter: Jenkins
Branch: master

commit 933259f67520d092d4a29d5287d823f3b08e44c3
Author: Sergey Skripnick <email address hidden>
Date: Fri May 17 18:18:35 2013 +0300

    Docstrings formatted according to pep257

    Bug #1020184

    Removed H404 from PEP8 ignore list.

    Change-Id: Iabc75281c5d92c5b399c24c9b65aca139f204b0a

Thierry Carrez (ttx)
Changed in quantum:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in neutron:
milestone: havana-1 → 2013.2
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

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