)]}'
{"doc/contributor-guide/source/writing-style/code-conventions.rst":[{"author":{"_account_id":10897,"name":"Joseph Robinson","email":"josephremail@gmail.com","username":"RobiJoe"},"change_message_id":"b37ab39c473a4c4af17c737c53efc27de50ae412","unresolved":false,"context_lines":[{"line_number":25,"context_line":""},{"line_number":26,"context_line":"* **Use capital letters with underline for parameters**"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"  When you write parameters as a command example,"},{"line_number":29,"context_line":"  use capital letters for parameters, with underline as delimiter."},{"line_number":30,"context_line":"  For example,"},{"line_number":31,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"dab17558_d2b58b31","line":28,"updated":"2016-05-10 01:06:23.000000000","message":"One suggestion - optional - swap some of the words around, and add \u0027in an\u0027, \u0027the\u0027, and change \u0027underline\u0027 to plural - \u0027When you write parameters in an example command, use capital letters for the parameter, with underlines as a delimiter.\u0027","commit_id":"51f3e999fb6e603a83a7953e3fea63a5b8f4db98"},{"author":{"_account_id":167,"name":"Christian Berendt","email":"berendt@osism.tech","username":"berendt"},"change_message_id":"e569bc00e1960dbdfba7cfcaa269a291c5c86150","unresolved":false,"context_lines":[{"line_number":34,"context_line":"     $ openstack user create --project PROJECT_A --password PASSWORD USERNAME"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"  Add the note about parameters, if necessary:"},{"line_number":37,"context_line":"  Replace PASSWORD with a suitable password."},{"line_number":38,"context_line":""},{"line_number":39,"context_line":".. note::"},{"line_number":40,"context_line":""}],"source_content_type":"text/x-rst","patch_set":3,"id":"dab17558_01f17a95","line":37,"updated":"2016-05-10 05:42:05.000000000","message":"This is a sample, should .. code-block:: be used here?","commit_id":"7065972becf707ead5a780b6814898e1efb586db"},{"author":{"_account_id":14643,"name":"Olga Gusarenko","email":"ogusarenko@mirantis.com","username":"Olga"},"change_message_id":"120fc5b1e611637346a01b3919552682a6c40d2a","unresolved":false,"context_lines":[{"line_number":23,"context_line":"  gain access to user-only or admin-only CLI commands, use ``.`` instead of"},{"line_number":24,"context_line":"  ``source``."},{"line_number":25,"context_line":""},{"line_number":26,"context_line":"* **Use capital letters with underline for the parameters**"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"  When you write parameters in an example command,"},{"line_number":29,"context_line":"  use capital letters for the parameters, with underline as a delimiter."}],"source_content_type":"text/x-rst","patch_set":4,"id":"dab17558_87f1fa03","line":26,"range":{"start_line":26,"start_character":29,"end_line":26,"end_character":38},"updated":"2016-05-10 06:51:18.000000000","message":"I\u0027ve looked up \"underline\" and its usage in a number of dictionaries and IBM style guide, and think it is more appropriate to use \"underscore\" instead of \"underline\" in this content. Though this is my subjective opinion, probably native speakers could comment more on this.","commit_id":"d7f1945e46d49988417288e4f6154b408d50b886"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"9e9860eacf0bbfc99a77323717a36453ad8c798f","unresolved":false,"context_lines":[{"line_number":23,"context_line":"  gain access to user-only or admin-only CLI commands, use ``.`` instead of"},{"line_number":24,"context_line":"  ``source``."},{"line_number":25,"context_line":""},{"line_number":26,"context_line":"* **Use capital letters with underline for the parameters**"},{"line_number":27,"context_line":""},{"line_number":28,"context_line":"  When you write parameters in an example command,"},{"line_number":29,"context_line":"  use capital letters for the parameters, with underline as a delimiter."}],"source_content_type":"text/x-rst","patch_set":4,"id":"dab17558_67a2164d","line":26,"range":{"start_line":26,"start_character":29,"end_line":26,"end_character":38},"in_reply_to":"dab17558_87f1fa03","updated":"2016-05-10 07:03:22.000000000","message":"thanks. changed.","commit_id":"d7f1945e46d49988417288e4f6154b408d50b886"},{"author":{"_account_id":14643,"name":"Olga Gusarenko","email":"ogusarenko@mirantis.com","username":"Olga"},"change_message_id":"120fc5b1e611637346a01b3919552682a6c40d2a","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"  .. code-block:: none"},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"     Replace PASSWORD with a suitable password."},{"line_number":41,"context_line":""},{"line_number":42,"context_line":".. note::"},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"dab17558_c774a269","line":40,"range":{"start_line":40,"start_character":4,"end_line":40,"end_character":47},"updated":"2016-05-10 06:51:18.000000000","message":"Do I understand this piece correctly? If necessary, describe the parameters in a separate code block.","commit_id":"d7f1945e46d49988417288e4f6154b408d50b886"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"9e9860eacf0bbfc99a77323717a36453ad8c798f","unresolved":false,"context_lines":[{"line_number":37,"context_line":""},{"line_number":38,"context_line":"  .. code-block:: none"},{"line_number":39,"context_line":""},{"line_number":40,"context_line":"     Replace PASSWORD with a suitable password."},{"line_number":41,"context_line":""},{"line_number":42,"context_line":".. note::"},{"line_number":43,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"dab17558_e78e06cf","line":40,"range":{"start_line":40,"start_character":4,"end_line":40,"end_character":47},"in_reply_to":"dab17558_c774a269","updated":"2016-05-10 07:03:22.000000000","message":"Done","commit_id":"d7f1945e46d49988417288e4f6154b408d50b886"},{"author":{"_account_id":14643,"name":"Olga Gusarenko","email":"ogusarenko@mirantis.com","username":"Olga"},"change_message_id":"5b3dece842f6e0ceeafd85e757efc9452c1acbac","unresolved":false,"context_lines":[{"line_number":33,"context_line":""},{"line_number":34,"context_line":"     $ openstack user create --project PROJECT_A --password PASSWORD USERNAME"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"  Add a note about parameters if necessary."},{"line_number":37,"context_line":"  For example, for the ``PASSWORD`` parameter:"},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"  .. code-block:: none"}],"source_content_type":"text/x-rst","patch_set":9,"id":"dab17558_b9553afb","line":36,"range":{"start_line":36,"start_character":8,"end_line":36,"end_character":12},"updated":"2016-05-10 08:27:17.000000000","message":"\"Add a note\" can be interpreted as \"Format the description of parameters as a note\". Can we change it to just \"If necessary, describe the parameters immediately after the example command block\"? This is the way most of such descriptions are formatted at the moment and we won\u0027t need to change it to follow our conventions. What do you think?","commit_id":"13107f1258ca73a74008ddeff85e2af8342dfaa7"},{"author":{"_account_id":10497,"name":"KATO Tomoyuki","email":"kato.tomoyuki@jp.fujitsu.com","username":"to222"},"change_message_id":"c0b722eb3ac304fa0dfe4580caf5afd2cac61739","unresolved":false,"context_lines":[{"line_number":33,"context_line":""},{"line_number":34,"context_line":"     $ openstack user create --project PROJECT_A --password PASSWORD USERNAME"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"  Add a note about parameters if necessary."},{"line_number":37,"context_line":"  For example, for the ``PASSWORD`` parameter:"},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"  .. code-block:: none"}],"source_content_type":"text/x-rst","patch_set":9,"id":"dab17558_3d9be473","line":36,"range":{"start_line":36,"start_character":8,"end_line":36,"end_character":12},"in_reply_to":"dab17558_b9553afb","updated":"2016-05-10 14:19:56.000000000","message":"I agree.","commit_id":"13107f1258ca73a74008ddeff85e2af8342dfaa7"},{"author":{"_account_id":14962,"name":"ologvinova","email":"ologvinova@mirantis.com","username":"ologvinova"},"change_message_id":"69017786e53a7a4ecf0669a9dc8b229ad7834929","unresolved":false,"context_lines":[{"line_number":33,"context_line":""},{"line_number":34,"context_line":"     $ openstack user create --project PROJECT_A --password PASSWORD USERNAME"},{"line_number":35,"context_line":""},{"line_number":36,"context_line":"  Add a note about parameters if necessary."},{"line_number":37,"context_line":"  For example, for the ``PASSWORD`` parameter:"},{"line_number":38,"context_line":""},{"line_number":39,"context_line":"  .. code-block:: none"}],"source_content_type":"text/x-rst","patch_set":9,"id":"dab17558_b939baf4","line":36,"range":{"start_line":36,"start_character":8,"end_line":36,"end_character":12},"in_reply_to":"dab17558_b9553afb","updated":"2016-05-10 08:54:55.000000000","message":"Makes sense, +1 Olya!","commit_id":"13107f1258ca73a74008ddeff85e2af8342dfaa7"}]}
