typo in Step class docstring from horizon.workflows.base

Bug #1352676 reported by Tianpeng Wang
8
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Dashboard (Horizon)
Fix Released
Low
Bhavani Shankar

Bug Description

In horizon/workflows/base.py

`.. attribute:: action` should be `.. attribute:: action_class`

Changed in horizon:
assignee: nobody → Jicksy John (jicksy-john)
Changed in horizon:
assignee: Jicksy John (jicksy-john) → nobody
assignee: nobody → Jicksy John (jicksy-john)
Changed in horizon:
importance: Undecided → Low
Revision history for this message
Rob Cresswell (robcresswell-deactivatedaccount) wrote :

Any progress on this bug?

Revision history for this message
Gary W. Smith (gary-w-smith) wrote :

Please also make the correspondiong adjustment to the exception text when it is not set:
https://github.com/openstack/horizon/blob/master/horizon/workflows/base.py#L296

Changed in horizon:
status: New → Confirmed
Revision history for this message
Bhavani Shankar (bhavi) wrote :

Is there any progress on this bug?

I have a trivial patch here attached for the same.

Hi Gary,

The exception text seems just fine I guess as the exception is raised when there is no action set and the docstring change would be mostly due to maintaining the consistency with the function name I think.

Please correct me if I am wrong somewhere

Regards
Bhavani

Revision history for this message
Tianpeng Wang (timonwong) wrote :

I haven't work on this bug yet, anyone who have fixes, feel free to commit the changes to gerrit.

@Bhavani
IMHO, It's a good idea to explicitly include the actual attribute name in the exception message, or you just get a attribute error with no idea about which attribute is wrong before reading the documentation or source code.

Sincerely,
Timon

Revision history for this message
Bhavani Shankar (bhavi) wrote :

Thanks Timon.

PFA updated trivial patch.

I'll open up a gerrit review tonight.

Regards
Bhavani

Changed in horizon:
status: Confirmed → In Progress
assignee: Jicksy John (jicksy-john) → Bhavani Shankar (bhavi)
Revision history for this message
Gary W. Smith (gary-w-smith) wrote :

My point about fixing the exception was to change the text to reflect that an 'action_class' must be specified since it was still referring to the old name of 'action'

Revision history for this message
Bhavani Shankar (bhavi) wrote :

Thanks Gary.

Have submitted a review here:

https://review.openstack.org/115199

Regards
Bhavani

Revision history for this message
Bhavani Shankar (bhavi) wrote :

Didnt mention the bug number in the commit by mistake.

Manually setting this to fix committed

Regards
Bhavani

Changed in horizon:
status: In Progress → Fix Committed
Akihiro Motoki (amotoki)
Changed in horizon:
milestone: none → juno-3
Thierry Carrez (ttx)
Changed in horizon:
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in horizon:
milestone: juno-3 → 2014.2
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.