docstrings do not conform to the format in HACKING
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Ceilometer |
Invalid
|
Undecided
|
Unassigned | ||
Cinder |
Invalid
|
Wishlist
|
Verónica Musso |
Bug Description
I have noticed many docstrings in source files do not confirm to the format in HACKING:
http://
For example, the definition of class cinder.
class APIRouter(
"""Routes requests on the API to the appropriate controller and method."""
ExtensionMa
An extra line should be placed after the docstring.
Not coincidentally, in other projects of openstack, there are many docstrings are lack of standardization.
such as:
def _sanitize_
'''Check the query to see if:
1) the request is coming from admin - then allow full visibility
2) non-admin - make sure that the query includes the requester's
project.
'''
q = copy.copy(query)
in /ceilometer\
I am not sure these should be standardized.
Is this a bug?
Changed in cinder: | |
assignee: | nobody → Verónica Musso (veronica-a-musso) |
Changed in ceilometer: | |
assignee: | nobody → Liusheng (liusheng) |
Changed in ceilometer: | |
assignee: | Liusheng (liusheng) → nobody |
status: | New → Invalid |
Changed in cinder: | |
assignee: | Esperanza Romero (esperanza-romero) → Verónica Musso (veronica-a-musso) |
Changed in cinder: | |
status: | In Progress → Invalid |
Yes, according to HACKING an extra line should be added after the docstring for classes.