Commit 21d81752 authored by Russell Keith-Magee's avatar Russell Keith-Magee
Browse files

Fixed #22193 -- Made hint a truly optional arugment on check messages. 

Thanks to Thomas Güttler for the suggestion.
parent 5679fce8

django/core/checks/messages.py

+1 −1
Original line number Diff line number Diff line
@@ -15,7 +15,7 @@ CRITICAL = 50 
@python_2_unicode_compatible

class CheckMessage(object):



    def __init__(self, level, msg, hint, obj=None, id=None):

    def __init__(self, level, msg, hint=None, obj=None, id=None):

        assert isinstance(level, int), "The first argument should be level."

        self.level = level

        self.msg = msg

docs/topics/checks.txt

+2 −6
Original line number Diff line number Diff line
@@ -78,12 +78,8 @@ Constructor arguments are: 


``hint``

    A single-line string providing a hint for fixing the problem. If no hint

    can be provided, or the hint is self-evident from the error message, a

    value of ``None`` can be used::



        Error('error message') # Will not work.

        Error('error message', None) # Good

        Error('error message', hint=None) # Better

    can be provided, or the hint is self-evident from the error message, the

    hint can be omitted, or a value of ``None`` can be used.



``obj``

    Optional. An object providing context for the message (for example, the