pylint/message/message_handler_mix_in.py
def _print_checker_doc(checker_name, info, stream=None):
        """Helper method for print_full_documentation.

        Also used by doc/exts/pylint_extensions.py.
        """
        if not stream:
            stream = sys.stdout

        doc = info.get("doc")
        module = info.get("module")
        msgs = info.get("msgs")
        options = info.get("options")
        reports = info.get("reports")

        checker_title = "%s checker" % (checker_name.replace("_", " ").title())

        if module:
            # Provide anchor to link against
            print(".. _%s:\n" % module, file=stream)
        print(checker_title, file=stream)
        print("~" * len(checker_title), file=stream)
        print("", file=stream)
        if module:
            print("This checker is provided by ``%s``." % module, file=stream)
        print("Verbatim name of the checker is ``%s``." % checker_name, file=stream)
        print("", file=stream)
        if doc:
            # Provide anchor to link against
            title = "{} Documentation".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            print(cleandoc(doc), file=stream)
            print("", file=stream)
        if options:
            title = "{} Options".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            _rest_format_section(stream, None, options)
            print("", file=stream)
        if msgs:
            title = "{} Messages".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            for msgid, msg in sorted(
                msgs.items(), key=lambda kv: (_MSG_ORDER.index(kv[0][0]), kv[1])
            ):
                msg = build_message_definition(checker_name, msgid, msg)
                print(msg.format_help(checkerref=False), file=stream)
            print("", file=stream)
        if reports:
            title = "{} Reports".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            for report in reports:
                print(":%s: %s" % report[:2], file=stream)
            print("", file=stream)
        print("", file=stream)
def _print_checker_doc(checker_name, info, stream=None):
        if not stream:
            stream = sys.stdout

        doc = info.get("doc")
        module = info.get("module")
        msgs = info.get("msgs")
        options = info.get("options")
        reports = info.get("reports")

        checker_title = "%s checker" % (checker_name.replace("_", " ").title())

        if module:
            # Provide anchor to link against
            print(".. _%s:\n" % module, file=stream)
        print(checker_title, file=stream)
        print("~" * len(checker_title), file=stream)
        print("", file=stream)
        if module:
            print("This checker is provided by ``%s``." % module, file=stream)
        print("Verbatim name of the checker is ``%s``." % checker_name, file=stream)
        print("", file=stream)
        if doc:
            # Provide anchor to link against
            title = "{} Documentation".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            print(cleandoc(doc), file=stream)
            print("", file=stream)
        if options:
            title = "{} Options".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            _rest_format_section(stream, None, options)
            print("", file=stream)
        if msgs:
            title = "{} Messages".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            for msgid, msg in sorted(
                msgs.items(), key=lambda kv: (_MSG_ORDER.index(kv[0][0]), kv[1])
            ):
                msg = build_message_definition(checker_name, msgid, msg)
                print(msg.format_help(checkerref=False), file=stream)
            print("", file=stream)
        if reports:
            title = "{} Reports".format(checker_title)
            print(title, file=stream)
            print("^" * len(title), file=stream)
            for report in reports:
                print(":%s: %s" % report[:2], file=stream)
            print("", file=stream)
        print("", file=stream)
def _print_checker_doc ( checker_name , info , stream = None ) : if not stream : stream = sys . stdout doc = info . get ( "doc" ) module = info . get ( "module" ) msgs = info . get ( "msgs" ) options = info . get ( "options" ) reports = info . get ( "reports" ) checker_title = "%s checker" % ( checker_name . replace ( "_" , " " ) . title ( ) ) if module : # Provide anchor to link against print ( ".. _%s:\n" % module , file = stream ) print ( checker_title , file = stream ) print ( "~" * len ( checker_title ) , file = stream ) print ( "" , file = stream ) if module : print ( "This checker is provided by ``%s``." % module , file = stream ) print ( "Verbatim name of the checker is ``%s``." % checker_name , file = stream ) print ( "" , file = stream ) if doc : # Provide anchor to link against title = "{} Documentation" . format ( checker_title ) print ( title , file = stream ) print ( "^" * len ( title ) , file = stream ) print ( cleandoc ( doc ) , file = stream ) print ( "" , file = stream ) if options : title = "{} Options" . format ( checker_title ) print ( title , file = stream ) print ( "^" * len ( title ) , file = stream ) _rest_format_section ( stream , None , options ) print ( "" , file = stream ) if msgs : title = "{} Messages" . format ( checker_title ) print ( title , file = stream ) print ( "^" * len ( title ) , file = stream ) for msgid , msg in sorted ( msgs . items ( ) , key = lambda kv : ( _MSG_ORDER . index ( kv [ 0 ] [ 0 ] ) , kv [ 1 ] ) ) : msg = build_message_definition ( checker_name , msgid , msg ) print ( msg . format_help ( checkerref = False ) , file = stream ) print ( "" , file = stream ) if reports : title = "{} Reports" . format ( checker_title ) print ( title , file = stream ) print ( "^" * len ( title ) , file = stream ) for report in reports : print ( ":%s: %s" % report [ : 2 ] , file = stream ) print ( "" , file = stream ) print ( "" , file = stream )
Helper method for print_full_documentation.

        Also used by doc/exts/pylint_extensions.py.
Helper method for print_full_documentation .