docs: explain Default nomenclature in api introduction

This commit is contained in:
Brian Mann
2017-06-24 15:55:48 -04:00
parent db65b0576a
commit e5453e0303
+2
View File
@@ -23,6 +23,8 @@ Each document attempts to cover the essentials of each method including:
- **Yields:** What is yielded (and in rare cases, returned) from the method.
- **Default:** What default assertions (if any) are automatically applied.
- **Timeout:** If defined, the amount of time the method allows to execute before throwing.
- **Examples:** Real world examples of using the methods.