openstack
/
tempest
Code Issues Proposed changes

Fix typo in Tempest Coding Guide. 

"doctstrings" was mis-spelled as "docstings" in
tempest/HACKING.html

Change-Id: I0ae2b84af718cc032cd031612a898895a2b3c21d
Closes-bug: #1484356
This commit is contained in:
Xicheng Chang 2015-08-13 14:02:52 -07:00 committed by Xicheng Chang
parent 3783d3e7f3
commit 6fb98ec084
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
HACKING.rst
View File

@ -275,7 +275,7 @@ itself, and thus have a different set of guidelines around them:
Test Documentation
------------------
For tests being added we need to require inline documentation in the form of
docstings to explain what is being tested. In API tests for a new API a class
docstrings to explain what is being tested. In API tests for a new API a class
level docstring should be added to an API reference doc. If one doesn't exist
a TODO comment should be put indicating that the reference needs to be added.
For individual API test cases a method level docstring should be used to