diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/ref/checks.txt | 12 | ||||
| -rw-r--r-- | docs/topics/checks.txt | 4 |
2 files changed, 8 insertions, 8 deletions
diff --git a/docs/ref/checks.txt b/docs/ref/checks.txt index de9633402f..c2849d5f74 100644 --- a/docs/ref/checks.txt +++ b/docs/ref/checks.txt @@ -17,7 +17,7 @@ API Reference ``CheckMessage`` ----------------- -.. class:: CheckMessage(level, msg, hint, obj=None, id=None) +.. class:: CheckMessage(level, msg, hint=None, obj=None, id=None) The warnings and errors raised by system checks must be instances of ``CheckMessage``. An instance encapsulates a single reportable error or @@ -60,11 +60,11 @@ There are subclasses to make creating messages with common levels easier. When using them you can omit the ``level`` argument because it is implied by the class name. -.. class:: Debug(msg, hint, obj=None, id=None) -.. class:: Info(msg, hint, obj=None, id=None) -.. class:: Warning(msg, hint, obj=None, id=None) -.. class:: Error(msg, hint, obj=None, id=None) -.. class:: Critical(msg, hint, obj=None, id=None) +.. class:: Debug(msg, hint=None, obj=None, id=None) +.. class:: Info(msg, hint=None, obj=None, id=None) +.. class:: Warning(msg, hint=None obj=None, id=None) +.. class:: Error(msg, hint=None, obj=None, id=None) +.. class:: Critical(msg, hint=None, obj=None, id=None) Builtin checks ============== diff --git a/docs/topics/checks.txt b/docs/topics/checks.txt index 9311475e6a..a019caa7c6 100644 --- a/docs/topics/checks.txt +++ b/docs/topics/checks.txt @@ -39,7 +39,7 @@ check function:: errors.append( Error( 'an error', - hint=None, + hint='A hint.', obj=checked_object, id='myapp.E001', ) @@ -195,7 +195,7 @@ Messages are comparable. That allows you to easily write tests:: expected_errors = [ Error( 'an error', - hint=None, + hint='A hint.', obj=checked_object, id='myapp.E001', ) |