Docstring for validators._soft_validate_additional_properties is incomplete

Bug #1494289 reported by Ed Leafe
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
OpenStack Compute (nova)
Fix Released
Low
Ed Leafe

Bug Description

The recent change to validators.py to allow for varying scheduler hints added the parameter 'additional_properties_value', which strongly affects the behavior of the method, but this behavior was not explained in the method's docstring. It was felt that we should merge the change and fix this later, so this bug report is to ensure that we don't forget.

https://github.com/openstack/nova/blob/master/nova/api/validation/validators.py#L78-L98

Ed Leafe (ed-leafe)
Changed in nova:
importance: Undecided → Low
assignee: nobody → Ed Leafe (ed-leafe)
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to nova (master)

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

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

Reviewed: https://review.openstack.org/222228
Committed: https://git.openstack.org/cgit/openstack/nova/commit/?id=eadcdccd74c091eebeef20a0a534c64a479e423d
Submitter: Jenkins
Branch: master

commit eadcdccd74c091eebeef20a0a534c64a479e423d
Author: EdLeafe <email address hidden>
Date: Thu Sep 10 14:46:48 2015 +0000

    Add missing information to docstring

    A recent change to the '_soft_validate_additional_properties()' method
    in nova/api/validation/validators.py added new behaviors without
    updating the docstring to reflect the new behaviors. Rather than block
    that patch from merging, it was felt that a follow-up patch to fix the
    docstring was preferable.

    Closes-bug: 1494289
    Change-Id: I3e32742a935b94eb211591bbf1e5695d5301101e

Changed in nova:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in nova:
milestone: none → liberty-rc1
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in nova:
milestone: liberty-rc1 → 12.0.0
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.