rally-openstack/rally_openstack/verification
Andrey Kurilin b9a90fafa0 [docs] fix invalid "rst" usage
* Fix an issue while splitting docstring to description of parameters
  and the description of the plugins itself. Method 'trip' uses the
  second line of docstring to identify the intend to cut. This logic
  bases on the fact that the first line of docstring doesn't have intend
  at all. Unfortunately, python docstring objects start with empty line
  which moves the actual first line to the second position.

* We do not use definitions in any existing plugins docstrings.
  Existance of such nodes while parsing text means that there is an
  issue with intend (redundant spaces) or missed new line between list
  title/description and actual list items. (the proper test is added)

* rst parser adds "system_message" nodes for any kind of warnings and
  errors. This behaviour can be used in our test to find all "invalid"
  things.

Change-Id: I348ccf140458b604a8cc29053d166c1610ad807d
2018-04-25 16:08:04 +00:00
..
tempest [docs] fix invalid "rst" usage 2018-04-25 16:08:04 +00:00
__init__.py Change structure and imports 2018-02-16 20:05:45 +02:00