Docstrings missing for some methods in heat/db/sqlalchemy/api.py

Bug #1342131 reported by Divakar Padiyar Nandavar
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Heat
Triaged
Low
Shashwat Srivastava

Bug Description

While reviewing one of the check-ins found that Docstrings is missing for some methods in heat/db/sqlalchemy/api.py

Changed in heat:
assignee: nobody → Divakar Padiyar Nandavar (divakar-padiyar-nandavar)
Zane Bitter (zaneb)
Changed in heat:
importance: Undecided → Low
Revision history for this message
Angus Salkeld (asalkeld) wrote :

And neither does: https://github.com/openstack/heat/blob/master/heat/db/api.py
but they are all *so* obvious, I just think this would be a waste of coding/reviewing time adding them.

for instance:
https://github.com/openstack/heat/blob/master/heat/db/sqlalchemy/api.py#L111

def resource_get_by_name_and_stack(context, resource_name, stack_id):
   """Get a resource by name and stack_id."""

Even if you fluff this out, you are really not adding any value, they are really painfully
obvious what they do.

Zane Bitter (zaneb)
Changed in heat:
status: New → Triaged
Revision history for this message
Shashwat Srivastava (shashwat-srivastava) wrote :

As no update assigning it to myself.

Changed in heat:
assignee: Divakar Padiyar Nandavar (divakar-padiyar-nandavar) → Shashwat Srivastava (shashwat-srivastava)
Rico Lin (rico-lin)
Changed in heat:
milestone: none → no-priority-tag-bugs
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.