Redundancy in a nova server name schema description

Bug #1225845 reported by Sahdev Zala
10
This bug affects 2 people
Affects Status Importance Assigned to Milestone
OpenStack Heat
Fix Released
Low
Clint Byrum

Bug Description

OS::Nova::Server 'name' property description creates a redundancy and inconsistency with rest of the docs:

name : String

    Optional server name

    Optional property.

Since doc lists whether a property is optional or not, no need to describe the property as "optional" like rest of the docs, for example,
key_name : String
    Name of keypair to inject into the server
    Optional property.

Sahdev Zala (spzala)
Changed in heat:
assignee: nobody → Sahdev Zala (spzala)
Changed in heat:
status: New → Triaged
importance: Undecided → Low
assignee: Sahdev Zala (spzala) → nobody
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to heat (master)

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

Changed in heat:
assignee: nobody → Clint Byrum (clint-fewbar)
status: Triaged → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to heat (master)

Reviewed: https://review.openstack.org/64566
Committed: https://git.openstack.org/cgit/openstack/heat/commit/?id=e6a9225a2af2c03d5efb62009bb31858870520f4
Submitter: Jenkins
Branch: master

commit e6a9225a2af2c03d5efb62009bb31858870520f4
Author: Clint Byrum <email address hidden>
Date: Tue Dec 31 08:39:19 2013 -0800

    Remove redundant word from OS::Nova::Server

    All parameters not marked as "Required" are optional. The documentation
    generated from the schemas will already note this, so having the word in
    the description is redundant.

    Change-Id: I1df10c598969e97d5c1c8ecd1c2896a59ae1d2d1
    Closes-Bug: #1225845

Changed in heat:
status: In Progress → Fix Committed
Thierry Carrez (ttx)
Changed in heat:
milestone: none → icehouse-2
status: Fix Committed → Fix Released
Thierry Carrez (ttx)
Changed in heat:
milestone: icehouse-2 → 2014.1
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.