)]}'
{"tests/unit/doc/test_docstrings.py":[{"author":{"_account_id":22960,"name":"Hai Shi","email":"shihai1992@gmail.com","username":"haishi"},"change_message_id":"9f67189ef9520194711a55c27e58b830b6ab9852","unresolved":false,"context_lines":[{"line_number":60,"context_line":"                           \"At least class \u0027{}\u0027 or method \u0027{}.run\u0027 \""},{"line_number":61,"context_line":"                           \"should contain a docstring\")"},{"line_number":62,"context_line":"                    inst_name \u003d plg_cls.get_name()"},{"line_number":63,"context_line":"                    msg_buffer.append(msg.format(inst_name,"},{"line_number":64,"context_line":"                                                 plg_cls.__name__,"},{"line_number":65,"context_line":"                                                 inst_name))"},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"    def _check_described_params(self, msg_buffer):"},{"line_number":68,"context_line":"        for plg_cls in plugin.Plugin.get_all():"}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_2db6b9dc","line":65,"range":{"start_line":63,"start_character":0,"end_line":65,"end_character":60},"updated":"2017-03-01 06:31:58.000000000","message":"I think `msg \u003d \"{0}.run xxx {1} xxx {0}.run\".format(inst_name, plg_cls.__name__)` would be better.","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":23094,"name":"Staroverov Anton","email":"avstaroverov@gmail.com","username":"astaroverov"},"change_message_id":"5372edd54c40c203df0aa589ecaac28299b7f812","unresolved":false,"context_lines":[{"line_number":60,"context_line":"                           \"At least class \u0027{}\u0027 or method \u0027{}.run\u0027 \""},{"line_number":61,"context_line":"                           \"should contain a docstring\")"},{"line_number":62,"context_line":"                    inst_name \u003d plg_cls.get_name()"},{"line_number":63,"context_line":"                    msg_buffer.append(msg.format(inst_name,"},{"line_number":64,"context_line":"                                                 plg_cls.__name__,"},{"line_number":65,"context_line":"                                                 inst_name))"},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"    def _check_described_params(self, msg_buffer):"},{"line_number":68,"context_line":"        for plg_cls in plugin.Plugin.get_all():"}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_4d4f6d92","line":65,"range":{"start_line":63,"start_character":0,"end_line":65,"end_character":60},"in_reply_to":"ba2be162_2db6b9dc","updated":"2017-03-01 06:53:38.000000000","message":"I don\u0027t think so","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":22960,"name":"Hai Shi","email":"shihai1992@gmail.com","username":"haishi"},"change_message_id":"2c1c3f2c768167f46b1a4d619ca7acf25193a5c4","unresolved":false,"context_lines":[{"line_number":60,"context_line":"                           \"At least class \u0027{}\u0027 or method \u0027{}.run\u0027 \""},{"line_number":61,"context_line":"                           \"should contain a docstring\")"},{"line_number":62,"context_line":"                    inst_name \u003d plg_cls.get_name()"},{"line_number":63,"context_line":"                    msg_buffer.append(msg.format(inst_name,"},{"line_number":64,"context_line":"                                                 plg_cls.__name__,"},{"line_number":65,"context_line":"                                                 inst_name))"},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"    def _check_described_params(self, msg_buffer):"},{"line_number":68,"context_line":"        for plg_cls in plugin.Plugin.get_all():"}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_c1ae68e5","line":65,"range":{"start_line":63,"start_character":0,"end_line":65,"end_character":60},"in_reply_to":"ba2be162_38215c4e","updated":"2017-03-02 17:05:37.000000000","message":"My point is if the first `{}.run` is equal the second `{}.run`,you can use the indexed position in the string and use `inst_name` once. Like `\u0027xxx\u0027.format(inst_name, plg_cls.__name__)`. In `\u0027xxx\u0027.format(inst_name, plg_cls.__name__, inst_name)`, we use the param of `inst_name` twice~~","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":22960,"name":"Hai Shi","email":"shihai1992@gmail.com","username":"haishi"},"change_message_id":"939987b639cc52067d6e2af3f6d1e96ee3a956f2","unresolved":false,"context_lines":[{"line_number":60,"context_line":"                           \"At least class \u0027{}\u0027 or method \u0027{}.run\u0027 \""},{"line_number":61,"context_line":"                           \"should contain a docstring\")"},{"line_number":62,"context_line":"                    inst_name \u003d plg_cls.get_name()"},{"line_number":63,"context_line":"                    msg_buffer.append(msg.format(inst_name,"},{"line_number":64,"context_line":"                                                 plg_cls.__name__,"},{"line_number":65,"context_line":"                                                 inst_name))"},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"    def _check_described_params(self, msg_buffer):"},{"line_number":68,"context_line":"        for plg_cls in plugin.Plugin.get_all():"}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_f67fde63","line":65,"range":{"start_line":63,"start_character":0,"end_line":65,"end_character":60},"in_reply_to":"ba2be162_4d4f6d92","updated":"2017-03-02 02:03:10.000000000","message":"pls see a sample: https://github.com/openstack/rally/blob/master/rally/api.py#L533-L538","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":23094,"name":"Staroverov Anton","email":"avstaroverov@gmail.com","username":"astaroverov"},"change_message_id":"e9a365ec5e82a11dce3a6778d54e0d2c221fda8a","unresolved":false,"context_lines":[{"line_number":60,"context_line":"                           \"At least class \u0027{}\u0027 or method \u0027{}.run\u0027 \""},{"line_number":61,"context_line":"                           \"should contain a docstring\")"},{"line_number":62,"context_line":"                    inst_name \u003d plg_cls.get_name()"},{"line_number":63,"context_line":"                    msg_buffer.append(msg.format(inst_name,"},{"line_number":64,"context_line":"                                                 plg_cls.__name__,"},{"line_number":65,"context_line":"                                                 inst_name))"},{"line_number":66,"context_line":""},{"line_number":67,"context_line":"    def _check_described_params(self, msg_buffer):"},{"line_number":68,"context_line":"        for plg_cls in plugin.Plugin.get_all():"}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_38215c4e","line":65,"range":{"start_line":63,"start_character":0,"end_line":65,"end_character":60},"in_reply_to":"ba2be162_f67fde63","updated":"2017-03-02 07:05:37.000000000","message":"Usage of indexed position in the string is not required for \u0027format\u0027 operation when all parameters are present as stand-alone values. Usage of indexed positions have sense in case when output parameters are present, for example, as a list.\nExample from docs:\n\u003e\u003e\u003e \u0027{0}, {1}, {2}\u0027.format(\u0027a\u0027, \u0027b\u0027, \u0027c\u0027)\n\u0027a, b, c\u0027\n\u003e\u003e\u003e \u0027{}, {}, {}\u0027.format(\u0027a\u0027, \u0027b\u0027, \u0027c\u0027)\n\u0027a, b, c\u0027\n\u003e\u003e\u003e \u0027{2}, {1}, {0}\u0027.format(\u0027a\u0027, \u0027b\u0027, \u0027c\u0027)\n\u0027c, b, a\u0027\n\u003e\u003e\u003e \u0027{2}, {1}, {0}\u0027.format(*\u0027abc\u0027)\n\u0027c, b, a\u0027\n\u003e\u003e\u003e \u0027{0}{1}{0}\u0027.format(\u0027abra\u0027, \u0027cad\u0027)\n\u0027abracadabra\u0027\n\u003e\u003e\u003e \u0027Coordinates: {latitude}, {longitude}\u0027.format(latitude\u003d\u002737.24N\u0027, longitude\u003d\u0027-115.81W\u0027)\n\u0027Coordinates: 37.24N, -115.81W\u0027\n\u003e\u003e\u003e coord \u003d {\u0027latitude\u0027: \u002737.24N\u0027, \u0027longitude\u0027: \u0027-115.81W\u0027}\n\u003e\u003e\u003e \u0027Coordinates: {latitude}, {longitude}\u0027.format(**coord)\n\u0027Coordinates: 37.24N, -115.81W\u0027","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":22960,"name":"Hai Shi","email":"shihai1992@gmail.com","username":"haishi"},"change_message_id":"9f67189ef9520194711a55c27e58b830b6ab9852","unresolved":false,"context_lines":[{"line_number":77,"context_line":"                        param_data \u003d plg_cls.get_info()[\"parameters\"]"},{"line_number":78,"context_line":"                    documented_params \u003d [p[\"name\"] for p in param_data]"},{"line_number":79,"context_line":"                    for param in params:"},{"line_number":80,"context_line":"                        if param not in ignored_params:"},{"line_number":81,"context_line":"                            if param not in documented_params:"},{"line_number":82,"context_line":"                                msg \u003d (\"Class: %(class)s Docstring for \""},{"line_number":83,"context_line":"                                       \"%(scenario)s should\""},{"line_number":84,"context_line":"                                       \" describe the \u0027%(param)s\u0027 parameter\""}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_4dbbedc4","line":81,"range":{"start_line":80,"start_character":0,"end_line":81,"end_character":62},"updated":"2017-03-01 06:31:58.000000000","message":"I think `if param not in ignored_params + documented_params` would be better.","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":23094,"name":"Staroverov Anton","email":"avstaroverov@gmail.com","username":"astaroverov"},"change_message_id":"5372edd54c40c203df0aa589ecaac28299b7f812","unresolved":false,"context_lines":[{"line_number":77,"context_line":"                        param_data \u003d plg_cls.get_info()[\"parameters\"]"},{"line_number":78,"context_line":"                    documented_params \u003d [p[\"name\"] for p in param_data]"},{"line_number":79,"context_line":"                    for param in params:"},{"line_number":80,"context_line":"                        if param not in ignored_params:"},{"line_number":81,"context_line":"                            if param not in documented_params:"},{"line_number":82,"context_line":"                                msg \u003d (\"Class: %(class)s Docstring for \""},{"line_number":83,"context_line":"                                       \"%(scenario)s should\""},{"line_number":84,"context_line":"                                       \" describe the \u0027%(param)s\u0027 parameter\""}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_cd5b5d53","line":81,"range":{"start_line":80,"start_character":0,"end_line":81,"end_character":62},"in_reply_to":"ba2be162_4dbbedc4","updated":"2017-03-01 06:53:38.000000000","message":"I don\u0027t think so","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":23094,"name":"Staroverov Anton","email":"avstaroverov@gmail.com","username":"astaroverov"},"change_message_id":"e9a365ec5e82a11dce3a6778d54e0d2c221fda8a","unresolved":false,"context_lines":[{"line_number":77,"context_line":"                        param_data \u003d plg_cls.get_info()[\"parameters\"]"},{"line_number":78,"context_line":"                    documented_params \u003d [p[\"name\"] for p in param_data]"},{"line_number":79,"context_line":"                    for param in params:"},{"line_number":80,"context_line":"                        if param not in ignored_params:"},{"line_number":81,"context_line":"                            if param not in documented_params:"},{"line_number":82,"context_line":"                                msg \u003d (\"Class: %(class)s Docstring for \""},{"line_number":83,"context_line":"                                       \"%(scenario)s should\""},{"line_number":84,"context_line":"                                       \" describe the \u0027%(param)s\u0027 parameter\""}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_d815a09b","line":81,"range":{"start_line":80,"start_character":0,"end_line":81,"end_character":62},"in_reply_to":"ba2be162_968f8222","updated":"2017-03-02 07:05:37.000000000","message":"Here are no any potential problems here. It\u0027s just improve readability of code","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":22960,"name":"Hai Shi","email":"shihai1992@gmail.com","username":"haishi"},"change_message_id":"939987b639cc52067d6e2af3f6d1e96ee3a956f2","unresolved":false,"context_lines":[{"line_number":77,"context_line":"                        param_data \u003d plg_cls.get_info()[\"parameters\"]"},{"line_number":78,"context_line":"                    documented_params \u003d [p[\"name\"] for p in param_data]"},{"line_number":79,"context_line":"                    for param in params:"},{"line_number":80,"context_line":"                        if param not in ignored_params:"},{"line_number":81,"context_line":"                            if param not in documented_params:"},{"line_number":82,"context_line":"                                msg \u003d (\"Class: %(class)s Docstring for \""},{"line_number":83,"context_line":"                                       \"%(scenario)s should\""},{"line_number":84,"context_line":"                                       \" describe the \u0027%(param)s\u0027 parameter\""}],"source_content_type":"text/x-python","patch_set":8,"id":"ba2be162_968f8222","line":81,"range":{"start_line":80,"start_character":0,"end_line":81,"end_character":62},"in_reply_to":"ba2be162_cd5b5d53","updated":"2017-03-02 02:03:10.000000000","message":"Ok, my suggestion have potentially memory issue. But one judging operation is enough;)","commit_id":"8d457e27a0458259849afb52258395b8feb290e0"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":33,"context_line":"            return (file.read().lower().split())"},{"line_number":34,"context_line":""},{"line_number":35,"context_line":"    def get_list(self):"},{"line_number":36,"context_line":"        return self._open_file("},{"line_number":37,"context_line":"            EXCEPTIONS_DOCSTR) + self._open_file(EXCEPTIONS_FORMAT)"},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"    def _assert_class_has_docstrings(self, obj, long_description\u003dTrue):"},{"line_number":40,"context_line":"        if not obj.__module__.startswith(\"rally.\"):"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_ad53f4e0","line":37,"range":{"start_line":36,"start_character":8,"end_line":37,"end_character":67},"updated":"2017-03-03 17:05:39.000000000","message":"you ignored my previous comment: this call will read file with exceptions for each plugin. It is redundant, really. It is better to do it once.\n\n   class DocstringsTestCase(test.TestCase):\n       def setUp(self):\n           super(DocstringsTestCase, self).setUp()\n           self.exceptions \u003d self._open_file(...)","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":36,"context_line":"        return self._open_file("},{"line_number":37,"context_line":"            EXCEPTIONS_DOCSTR) + self._open_file(EXCEPTIONS_FORMAT)"},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"    def _assert_class_has_docstrings(self, obj, long_description\u003dTrue):"},{"line_number":40,"context_line":"        if not obj.__module__.startswith(\"rally.\"):"},{"line_number":41,"context_line":"            return"},{"line_number":42,"context_line":""},{"line_number":43,"context_line":"        self.assertIsNotNone(obj.__doc__,"},{"line_number":44,"context_line":"                             \"%s doesn\u0027t have a class-level docstring.\" %"},{"line_number":45,"context_line":"                             obj)"},{"line_number":46,"context_line":"        doc \u003d info.parse_docstring(obj.__doc__)"},{"line_number":47,"context_line":"        self.assertIsNotNone("},{"line_number":48,"context_line":"            doc[\"short_description\"],"},{"line_number":49,"context_line":"            \"Docstring for %s should have a one-line description.\" % obj)"},{"line_number":50,"context_line":"        if long_description:"},{"line_number":51,"context_line":"            self.assertIsNotNone("},{"line_number":52,"context_line":"                doc[\"long_description\"],"},{"line_number":53,"context_line":"                \"Docstring for %s should have a multi-line description.\" % obj)"},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"    def _check_docstrings(self, msg_buffer):"},{"line_number":56,"context_line":"        for plg_cls in plugin.Plugin.get_all():"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_6d8bbcc3","line":53,"range":{"start_line":39,"start_character":0,"end_line":53,"end_character":79},"updated":"2017-03-03 17:05:39.000000000","message":"it is not used anywhere.","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":53,"context_line":"                \"Docstring for %s should have a multi-line description.\" % obj)"},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"    def _check_docstrings(self, msg_buffer):"},{"line_number":56,"context_line":"        for plg_cls in plugin.Plugin.get_all():"},{"line_number":57,"context_line":"            if plg_cls.get_name().lower() not in self.get_list():"},{"line_number":58,"context_line":"                if not plg_cls.get_info()[\"title\"]:"},{"line_number":59,"context_line":"                    msg \u003d (\"\u0027{0}.run\u0027 doesn\u0027t have a docstring. \""}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_6d79fcc7","line":56,"updated":"2017-03-03 17:05:39.000000000","message":"let\u0027s add here a check like at L40. we do not need to check \"test\" plugins","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":56,"context_line":"        for plg_cls in plugin.Plugin.get_all():"},{"line_number":57,"context_line":"            if plg_cls.get_name().lower() not in self.get_list():"},{"line_number":58,"context_line":"                if not plg_cls.get_info()[\"title\"]:"},{"line_number":59,"context_line":"                    msg \u003d (\"\u0027{0}.run\u0027 doesn\u0027t have a docstring. \""},{"line_number":60,"context_line":"                           \"At least class \u0027{1}\u0027 or method \u0027{0}.run\u0027 \""},{"line_number":61,"context_line":"                           \"should contain a docstring\")"},{"line_number":62,"context_line":"                    inst_name \u003d plg_cls.get_name()"},{"line_number":63,"context_line":"                    msg_buffer.append(msg.format(inst_name,"},{"line_number":64,"context_line":"                                                 plg_cls.__name__))"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_2d9d440a","line":61,"range":{"start_line":59,"start_character":20,"end_line":61,"end_character":56},"updated":"2017-03-03 17:05:39.000000000","message":"please unify message to cover not only scenarios. For example, msg can be that same as at L49\n\nAlso, it would be nice to check \"description\" here too","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":71,"context_line":"                    code_block \u003d plg_cls.run.__code__"},{"line_number":72,"context_line":"                    params_count \u003d code_block.co_argcount"},{"line_number":73,"context_line":"                    params \u003d code_block.co_varnames[:params_count]"},{"line_number":74,"context_line":"                    param_data \u003d {}"},{"line_number":75,"context_line":"                    if plg_cls.get_info()[\"parameters\"]:"},{"line_number":76,"context_line":"                        param_data \u003d plg_cls.get_info()[\"parameters\"]"},{"line_number":77,"context_line":"                    documented_params \u003d [p[\"name\"] for p in param_data]"},{"line_number":78,"context_line":"                    for param in params:"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_10897375","line":75,"range":{"start_line":74,"start_character":20,"end_line":75,"end_character":56},"updated":"2017-03-03 17:05:39.000000000","message":"these lines are redundant L76 should be enough(it return empty list in case of no documented parametes)","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":86,"context_line":"                                          \"scenario\": plg_cls.get_name(),"},{"line_number":87,"context_line":"                                          \"param\": param})"},{"line_number":88,"context_line":"                                msg_buffer.append(msg)"},{"line_number":89,"context_line":"                else:"},{"line_number":90,"context_line":"                    doc \u003d info.parse_docstring(plg_cls.__doc__)"},{"line_number":91,"context_line":"                    short_description \u003d doc[\"short_description\"]"},{"line_number":92,"context_line":"                    if short_description.startswith(\"Test\"):"},{"line_number":93,"context_line":"                        msg_buffer.append(\"One-line description for %s should\""},{"line_number":94,"context_line":"                                          \" be declarative and not start \""},{"line_number":95,"context_line":"                                          \"with \u0027Test(s) ...\u0027\""},{"line_number":96,"context_line":"                                          % plg_cls.__name__)"},{"line_number":97,"context_line":""},{"line_number":98,"context_line":"    def test_all_scenarios_have_docstrings(self):"},{"line_number":99,"context_line":""}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_30c837a8","line":96,"range":{"start_line":89,"start_character":0,"end_line":96,"end_character":61},"updated":"2017-03-03 17:05:39.000000000","message":"it should be checked for all plugins at _check_docstrings method","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":95,"context_line":"                                          \"with \u0027Test(s) ...\u0027\""},{"line_number":96,"context_line":"                                          % plg_cls.__name__)"},{"line_number":97,"context_line":""},{"line_number":98,"context_line":"    def test_all_scenarios_have_docstrings(self):"},{"line_number":99,"context_line":""},{"line_number":100,"context_line":"        msg_buffer \u003d []"},{"line_number":101,"context_line":""}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_cd44a8b8","line":98,"range":{"start_line":98,"start_character":8,"end_line":98,"end_character":42},"updated":"2017-03-03 17:05:39.000000000","message":"It checks not only scenarios, please modify test name","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":100,"context_line":"        msg_buffer \u003d []"},{"line_number":101,"context_line":""},{"line_number":102,"context_line":"        self._check_docstrings(msg_buffer)"},{"line_number":103,"context_line":"        self.assertEqual([], msg_buffer)"},{"line_number":104,"context_line":""},{"line_number":105,"context_line":"        self._check_described_params(msg_buffer)"},{"line_number":106,"context_line":"        self.assertEqual([], msg_buffer)"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_4d5a782b","line":103,"range":{"start_line":103,"start_character":8,"end_line":103,"end_character":40},"updated":"2017-03-03 17:05:39.000000000","message":"To have more user-friendly message, it is better to write in in the next way:\n\n   if msg_buffer:\n       self.fail(\"\\n\\n\".join(msg_buffer))","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":103,"context_line":"        self.assertEqual([], msg_buffer)"},{"line_number":104,"context_line":""},{"line_number":105,"context_line":"        self._check_described_params(msg_buffer)"},{"line_number":106,"context_line":"        self.assertEqual([], msg_buffer)"},{"line_number":107,"context_line":""},{"line_number":108,"context_line":"    # def test_all_deploy_engines_have_docstrings(self):"},{"line_number":109,"context_line":"    #     for deploy_engine in engine.Engine.get_all():"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_6d43bc42","line":106,"range":{"start_line":106,"start_character":8,"end_line":106,"end_character":40},"updated":"2017-03-03 17:05:39.000000000","message":"same here","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"aba78b918d3e5b608a9bb7c5586498bab439869e","unresolved":false,"context_lines":[{"line_number":104,"context_line":""},{"line_number":105,"context_line":"        self._check_described_params(msg_buffer)"},{"line_number":106,"context_line":"        self.assertEqual([], msg_buffer)"},{"line_number":107,"context_line":""},{"line_number":108,"context_line":"    # def test_all_deploy_engines_have_docstrings(self):"},{"line_number":109,"context_line":"    #     for deploy_engine in engine.Engine.get_all():"},{"line_number":110,"context_line":"    #         self._assert_class_has_docstrings(deploy_engine)"},{"line_number":111,"context_line":"    #"},{"line_number":112,"context_line":"    # def test_all_server_providers_have_docstrings(self):"},{"line_number":113,"context_line":"    #     for _provider in provider.ProviderFactory.get_all():"},{"line_number":114,"context_line":"    #         self._assert_class_has_docstrings(_provider)"},{"line_number":115,"context_line":"    #"},{"line_number":116,"context_line":"    # def test_all_SLA_have_docstrings(self):"},{"line_number":117,"context_line":"    #     for s in discover.itersubclasses(sla.SLA):"},{"line_number":118,"context_line":"    #         self._assert_class_has_docstrings(s, long_description\u003dFalse)"}],"source_content_type":"text/x-python","patch_set":9,"id":"ba2be162_ed008c03","line":118,"range":{"start_line":107,"start_character":0,"end_line":118,"end_character":74},"updated":"2017-03-03 17:05:39.000000000","message":"it is not needed anymore","commit_id":"fc472f93194d29559c4d0947060d8a61e269af15"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"56bb9f14e6d0befd6246dd56548323f992c6d0ce","unresolved":false,"context_lines":[{"line_number":31,"context_line":"    def setUp(self):"},{"line_number":32,"context_line":"        super(DocstringsTestCase, self).setUp()"},{"line_number":33,"context_line":"        self.exceptions \u003d self._open_file("},{"line_number":34,"context_line":"            EXCEPTIONS_DOCSTR) + self._open_file(EXCEPTIONS_FORMAT)"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"    def _open_file(self, filename):"},{"line_number":37,"context_line":"        with open(\"./tests/unit/doc/%s\" % filename) as file:"}],"source_content_type":"text/x-python","patch_set":10,"id":"ba2be162_2d434e6d","line":34,"updated":"2017-03-06 10:10:23.000000000","message":"one more thing that we should add here:\n\n\n    from rally import plugins\n\n    ...\n    plugins.load()\n\nBy default we do not load all plugins","commit_id":"948e84fbe7030b0462a7bdd05aad4d86e57e0831"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"56bb9f14e6d0befd6246dd56548323f992c6d0ce","unresolved":false,"context_lines":[{"line_number":75,"context_line":"                                          \"param\": param})"},{"line_number":76,"context_line":"                                msg_buffer.append(msg)"},{"line_number":77,"context_line":""},{"line_number":78,"context_line":"    def test_all_scenarios_and_plugins_have_docstrings(self):"},{"line_number":79,"context_line":""},{"line_number":80,"context_line":"        msg_buffer \u003d []"},{"line_number":81,"context_line":"        self._check_docstrings(msg_buffer)"}],"source_content_type":"text/x-python","patch_set":10,"id":"ba2be162_cda4724c","line":78,"range":{"start_line":78,"start_character":8,"end_line":78,"end_character":54},"updated":"2017-03-06 10:10:23.000000000","message":"just `test_all_plugins_have_docstrings`","commit_id":"948e84fbe7030b0462a7bdd05aad4d86e57e0831"}],"tests/unit/docstrings/__init__.py":[{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[],"source_content_type":"","patch_set":5,"id":"fa31d9ce_c469798d","side":"PARENT","line":1,"updated":"2017-02-10 11:55:35.000000000","message":"no need to create additional module, let\u0027s use tests/unit/doc","commit_id":"c3a8c8a5733805529bc0d5effa7cdc7ea014b8bb"}],"tests/unit/docstrings/docstrings_exceptions.py":[{"author":{"_account_id":13404,"name":"Alberto Planas","email":"aplanas@gmail.com","username":"aplanas"},"change_message_id":"ee51bc4369c83e8da7c3b0fea9e51b3abf1f2a25","unresolved":false,"context_lines":[{"line_number":1,"context_line":"# Copyright 2014: Mirantis Inc."},{"line_number":2,"context_line":"# All Rights Reserved."},{"line_number":3,"context_line":"#"},{"line_number":4,"context_line":"#    Licensed under the Apache License, Version 2.0 (the \"License\"); you may"}],"source_content_type":"text/x-python","patch_set":5,"id":"1a430d35_07779cd3","line":1,"updated":"2017-02-07 15:10:57.000000000","message":"if the file is new maybe this is for 2017","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[{"line_number":13,"context_line":"#    License for the specific language governing permissions and limitations"},{"line_number":14,"context_line":"#    under the License."},{"line_number":15,"context_line":""},{"line_number":16,"context_line":"EXCEPTIONS_DOCSTR \u003d \"missed_docstrings.txt\""},{"line_number":17,"context_line":"EXCEPTIONS_FORMAT \u003d \"wrong_format.txt\""},{"line_number":18,"context_line":""},{"line_number":19,"context_line":""},{"line_number":20,"context_line":"def _open_file(filename):"},{"line_number":21,"context_line":"    with open(\"./tests/unit/docstrings/%s\" % filename) as file:"},{"line_number":22,"context_line":"        return(file.read().split())"},{"line_number":23,"context_line":""},{"line_number":24,"context_line":""},{"line_number":25,"context_line":"def get_list():"},{"line_number":26,"context_line":"    return _open_file(EXCEPTIONS_DOCSTR) + _open_file(EXCEPTIONS_FORMAT)"}],"source_content_type":"text/x-python","patch_set":5,"id":"fa31d9ce_e404bdc7","line":26,"range":{"start_line":16,"start_character":0,"end_line":26,"end_character":72},"updated":"2017-02-10 11:55:35.000000000","message":"let\u0027s include that stuff in original test_docsting file","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"}],"tests/unit/test_docstrings.py":[{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[{"line_number":1,"context_line":"# Copyright 2014: Mirantis Inc."},{"line_number":2,"context_line":"# All Rights Reserved."},{"line_number":3,"context_line":"#"},{"line_number":4,"context_line":"#    Licensed under the Apache License, Version 2.0 (the \"License\"); you may"}],"source_content_type":"text/x-python","patch_set":5,"id":"fa31d9ce_a46c859d","line":1,"updated":"2017-02-10 11:55:35.000000000","message":"It would be nice to move that test under tests/unit/doc module","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[{"line_number":42,"context_line":"                \"Docstring for %s should have a multi-line description.\" % obj)"},{"line_number":43,"context_line":""},{"line_number":44,"context_line":"    def _check_docstrings(self, msg_buffer):"},{"line_number":45,"context_line":"        for plg_name in plugin.Plugin.get_all():"},{"line_number":46,"context_line":"            if plg_name.__name__ not in exception_list.get_list():"},{"line_number":47,"context_line":"                if not plg_name.__doc__:"},{"line_number":48,"context_line":"                    msg \u003d (\"Docstring for {} should have at least a one-line\""}],"source_content_type":"text/x-python","patch_set":5,"id":"fa31d9ce_c4bb390d","line":45,"range":{"start_line":45,"start_character":12,"end_line":45,"end_character":20},"updated":"2017-02-10 11:55:35.000000000","message":"s/plg_name/plg_cls","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[{"line_number":44,"context_line":"    def _check_docstrings(self, msg_buffer):"},{"line_number":45,"context_line":"        for plg_name in plugin.Plugin.get_all():"},{"line_number":46,"context_line":"            if plg_name.__name__ not in exception_list.get_list():"},{"line_number":47,"context_line":"                if not plg_name.__doc__:"},{"line_number":48,"context_line":"                    msg \u003d (\"Docstring for {} should have at least a one-line\""},{"line_number":49,"context_line":"                           \" description.\").format(plg_name.__name__)"},{"line_number":50,"context_line":"                    if hasattr(plg_name, \"run\"):"},{"line_number":51,"context_line":"                        msg \u003d (\"\u0027{}.run\u0027 doesn\u0027t have a docstring. \""},{"line_number":52,"context_line":"                               \"At least class \u0027{}\u0027 or method \u0027{}.run\u0027 \""},{"line_number":53,"context_line":"                               \"should contain a docstring\")"},{"line_number":54,"context_line":"                        inst_name \u003d plg_name.__name__"},{"line_number":55,"context_line":"                        if not plg_name.run.__doc__:"},{"line_number":56,"context_line":"                            msg_buffer.append(msg.format(inst_name,"},{"line_number":57,"context_line":"                                                         inst_name,"}],"source_content_type":"text/x-python","patch_set":5,"id":"fa31d9ce_6468cdbb","line":54,"range":{"start_line":47,"start_character":17,"end_line":54,"end_character":53},"updated":"2017-02-10 11:55:35.000000000","message":"actually, there is no need to check for method run. No one access to `__doc__` property directly. get_info (https://github.com/openstack/rally/blob/master/rally/common/plugin/info.py#L94) is used in all places. It already contains a logic for the scenario method `run`.\n\nYou should just call that method and check title, description and parameters keys","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[{"line_number":59,"context_line":"                    else:"},{"line_number":60,"context_line":"                        msg_buffer.append(msg)"},{"line_number":61,"context_line":""},{"line_number":62,"context_line":"    def _check_described_params(self, msg_buffer):"},{"line_number":63,"context_line":"        for plg_name in plugin.Plugin.get_all():"},{"line_number":64,"context_line":"            if plg_name.__name__ not in exception_list.get_list():"},{"line_number":65,"context_line":"                ignored_params \u003d [\"self\", \"scenario_obj\"]"},{"line_number":66,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"fa31d9ce_04d55142","line":63,"range":{"start_line":62,"start_character":4,"end_line":63,"end_character":48},"updated":"2017-02-10 11:55:35.000000000","message":"let\u0027s do not go throw list of plugins twice and call the method _check_described_params from _check_docstings (in case of isinstance(plg_name, scenario.Scenario))","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"},{"author":{"_account_id":9545,"name":"Andriy Kurilin","email":"andr.kurilin@gmail.com","username":"akurilin"},"change_message_id":"9b0b060fc32510864b6578ea7dfbb54fbea66a7f","unresolved":false,"context_lines":[{"line_number":92,"context_line":"                                          \"with \u0027Test(s) ...\u0027\""},{"line_number":93,"context_line":"                                          % plg_name.__name__)"},{"line_number":94,"context_line":""},{"line_number":95,"context_line":"    def test_all_scenarios_have_docstrings(self):"},{"line_number":96,"context_line":""},{"line_number":97,"context_line":"        msg_buffer \u003d []"},{"line_number":98,"context_line":""}],"source_content_type":"text/x-python","patch_set":5,"id":"fa31d9ce_a92f00a0","line":95,"range":{"start_line":95,"start_character":8,"end_line":95,"end_character":49},"updated":"2017-02-10 11:55:35.000000000","message":"You make this test cover all plugins(not only scenarios). Great! So let\u0027s rename it and remove L105-115","commit_id":"dfba06dbf2e846f50bbc4d3ceb3448531b633cb1"}]}
