pylint/message/message_handler_mix_in.py
def print_full_documentation(self, stream=None):
        """output a full documentation in ReST format"""
        if not stream:
            stream = sys.stdout

        print("Pylint global options and switches", file=stream)
        print("----------------------------------", file=stream)
        print("", file=stream)
        print("Pylint provides global options and switches.", file=stream)
        print("", file=stream)

        by_checker = {}
        for checker in self.get_checkers():
            if checker.name == "master":
                if checker.options:
                    for section, options in checker.options_by_section():
                        if section is None:
                            title = "General options"
                        else:
                            title = "%s options" % section.capitalize()
                        print(title, file=stream)
                        print("~" * len(title), file=stream)
                        _rest_format_section(stream, None, options)
                        print("", file=stream)
            else:
                name = checker.name
                try:
                    by_checker[name]["options"] += checker.options_and_values()
                    by_checker[name]["msgs"].update(checker.msgs)
                    by_checker[name]["reports"] += checker.reports
                except KeyError:
                    by_checker[name] = {
                        "options": list(checker.options_and_values()),
                        "msgs": dict(checker.msgs),
                        "reports": list(checker.reports),
                    }

        print("Pylint checkers' options and switches", file=stream)
        print("-------------------------------------", file=stream)
        print("", file=stream)
        print("Pylint checkers can provide three set of features:", file=stream)
        print("", file=stream)
        print("* options that control their execution,", file=stream)
        print("* messages that they can raise,", file=stream)
        print("* reports that they can generate.", file=stream)
        print("", file=stream)
        print("Below is a list of all checkers and their features.", file=stream)
        print("", file=stream)

        for checker, info in sorted(by_checker.items()):
            self._print_checker_doc(checker, info, stream=stream)
def print_full_documentation(self, stream=None):
        """output a full documentation in ReST format"""
        if not stream:
            stream = sys.stdout

        print("Pylint global options and switches", file=stream)
        print("----------------------------------", file=stream)
        print("", file=stream)
        print("Pylint provides global options and switches.", file=stream)
        print("", file=stream)

        by_checker = {}
        for checker in self.get_checkers():
            if checker.name == "master":
                if checker.options:
                    for section, options in checker.options_by_section():
                        if section is None:
                            title = "General options"
                        else:
                            title = "%s options" % section.capitalize()
                        print(title, file=stream)
                        print("~" * len(title), file=stream)
                        _rest_format_section(stream, None, options)
                        print("", file=stream)
            else:
                name = checker.name
                try:
                    by_checker[name]["options"] += checker.options_and_values()
                    by_checker[name]["msgs"].update(checker.msgs)
                    by_checker[name]["reports"] += checker.reports
                except KeyError:
                    by_checker[name] = {
                        "options": list(checker.options_and_values()),
                        "msgs": dict(checker.msgs),
                        "reports": list(checker.reports),
                    }

        print("Pylint checkers' options and switches", file=stream)
        print("-------------------------------------", file=stream)
        print("", file=stream)
        print("Pylint checkers can provide three set of features:", file=stream)
        print("", file=stream)
        print("* options that control their execution,", file=stream)
        print("* messages that they can raise,", file=stream)
        print("* reports that they can generate.", file=stream)
        print("", file=stream)
        print("Below is a list of all checkers and their features.", file=stream)
        print("", file=stream)

        for checker, info in sorted(by_checker.items()):
            self._print_checker_doc(checker, info, stream=stream)
def print_full_documentation ( self , stream = None ) : if not stream : stream = sys . stdout print ( "Pylint global options and switches" , file = stream ) print ( "----------------------------------" , file = stream ) print ( "" , file = stream ) print ( "Pylint provides global options and switches." , file = stream ) print ( "" , file = stream ) by_checker = { } for checker in self . get_checkers ( ) : if checker . name == "master" : if checker . options : for section , options in checker . options_by_section ( ) : if section is None : title = "General options" else : title = "%s options" % section . capitalize ( ) print ( title , file = stream ) print ( "~" * len ( title ) , file = stream ) _rest_format_section ( stream , None , options ) print ( "" , file = stream ) else : name = checker . name try : by_checker [ name ] [ "options" ] += checker . options_and_values ( ) by_checker [ name ] [ "msgs" ] . update ( checker . msgs ) by_checker [ name ] [ "reports" ] += checker . reports except KeyError : by_checker [ name ] = { "options" : list ( checker . options_and_values ( ) ) , "msgs" : dict ( checker . msgs ) , "reports" : list ( checker . reports ) , } print ( "Pylint checkers' options and switches" , file = stream ) print ( "-------------------------------------" , file = stream ) print ( "" , file = stream ) print ( "Pylint checkers can provide three set of features:" , file = stream ) print ( "" , file = stream ) print ( "* options that control their execution," , file = stream ) print ( "* messages that they can raise," , file = stream ) print ( "* reports that they can generate." , file = stream ) print ( "" , file = stream ) print ( "Below is a list of all checkers and their features." , file = stream ) print ( "" , file = stream ) for checker , info in sorted ( by_checker . items ( ) ) : self . _print_checker_doc ( checker , info , stream = stream )
output a full documentation in ReST format
output a full documentation in ReST format