python-openstackclient/openstackclient
Tang Chen 35833f7bd8 Fix DisplayCommandBase comments for cliff ShowOne subclass tests
As bug #1477199 describes, the wrong comment below is all over the
unit test code of OSC.

    # DisplayCommandBase.take_action() returns two tuples

There is no such class named DisplayCommandBase in OSC. It is in cliff.

All OSC command classes inherit from the base classes in cliff,
class Command, class Lister and class ShowOne. It is like this:

Object
|--> Command
     |--> DisplayCommandBase
          |--> Lister
          |--> ShowOne

take_action() is an abstract method of class Command, and generally is
overwritten by subclasses.
* Command.take_action() returns nothing.
* Lister.take_action() returns a tuple which contains a tuple of columns
  and a generator used to generate the data.
* ShowOne.take_action() returns an iterator which contains a tuple of
  columns and a tuple of data.

So, this problem should be fixed in 3 steps:
1. Remove all DisplayCommandBase comments for tests of classes inheriting
   from class Command in cliff as it returns nothing.
2. Fix all DisplayCommandBase comments for tests of classes inheriting
   from class Lister in cliff. Lister.take_action() returns a tuple and
   a generator.
3. Fix all DisplayCommandBase comments for tests of classes inheriting
   from class ShowOne in cliff. ShowOne.take_action() returns two tuples.

This patch finishes step 3 in all but identity tests. There are too many
such comments in identity tests. So fix them all in another patch.

Change-Id: I1afe4852069d25d562a9448ec2bf2cff58955052
Partial-bug: #1477199
2016-02-10 13:31:38 +08:00
..
api Fix a spell typos 2016-02-03 15:47:25 +05:30
common Merge "Support listing network availability zones" 2016-02-04 00:40:09 +00:00
compute Add support for triggering an crash dump 2016-02-05 21:48:41 +08:00
identity log take_action parameters in a single place 2016-02-02 09:58:32 +09:00
image Add --marker option to "image list" command 2016-02-03 14:04:50 +08:00
locale Update translation setup 2016-01-29 08:18:50 +09:00
network Merge "Minor typo in help text" 2016-02-04 00:43:09 +00:00
object Add recursive object delete for containers 2016-02-05 11:18:46 -07:00
tests Fix DisplayCommandBase comments for cliff ShowOne subclass tests 2016-02-10 13:31:38 +08:00
volume log take_action parameters in a single place 2016-02-02 09:58:32 +09:00
__init__.py Change version reporting to use pbr 2013-08-02 12:11:49 -05:00
i18n.py Update translation setup 2016-01-29 08:18:50 +09:00
shell.py The format_exc method does not take an exception 2015-12-08 09:23:47 -07:00