)]}'
{"doc/source/styleguide.rst":[{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"9147a9f932c7059e4c2054c6db1e11a8b1ada761","unresolved":false,"context_lines":[{"line_number":2,"context_line":"Style Guide for Help Strings"},{"line_number":3,"context_line":"----------------------------"},{"line_number":4,"context_line":""},{"line_number":5,"context_line":"This document describes some style guidelines for the help strings of "},{"line_number":6,"context_line":"config options. These help strings are a requirement for each option."},{"line_number":7,"context_line":"The help strings are not only used inside the code but also in the"},{"line_number":8,"context_line":"sample config files, like ``etc/cinder/cinder.conf``, and all of them are"}],"source_content_type":"text/x-rst","patch_set":1,"id":"AAAAUH%2F%2BYPw%3D","line":5,"updated":"2014-01-27 15:14:17.000000000","message":"a bit of trailing whitespace there","commit_id":"ac764bc1a357ac37319e236f8f87ab188f037435"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"f36af82b68522a203f90139fd866d6da6e1f6591","unresolved":false,"context_lines":[{"line_number":2,"context_line":"Style Guide for Help Strings"},{"line_number":3,"context_line":"----------------------------"},{"line_number":4,"context_line":""},{"line_number":5,"context_line":"This document describes some style guidelines for the help strings of "},{"line_number":6,"context_line":"config options. These help strings are a requirement for each option."},{"line_number":7,"context_line":"The help strings are not only used inside the code but also in the"},{"line_number":8,"context_line":"sample config files, like ``etc/cinder/cinder.conf``, and all of them are"}],"source_content_type":"text/x-rst","patch_set":1,"id":"AAAAUH%2F%2BYOE%3D","line":5,"in_reply_to":"AAAAUH%2F%2BYPw%3D","updated":"2014-01-27 15:15:57.000000000","message":"Done","commit_id":"ac764bc1a357ac37319e236f8f87ab188f037435"},{"author":{"_account_id":2472,"name":"Doug Hellmann","email":"dhellmann@redhat.com","username":"doug-hellmann"},"change_message_id":"9147a9f932c7059e4c2054c6db1e11a8b1ada761","unresolved":false,"context_lines":[{"line_number":27,"context_line":"1. Use sentence style capitalization for the strings, this means: The"},{"line_number":28,"context_line":"   first character should be uppercase."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi line strings, add a space at the end of the line."},{"line_number":31,"context_line":""},{"line_number":32,"context_line":"3. Only use single spaces, no double spaces."},{"line_number":33,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"AAAAUH%2F%2BYOc%3D","line":30,"updated":"2014-01-27 15:14:17.000000000","message":"I think I understand what you mean, but an example would help clarify this.","commit_id":"ac764bc1a357ac37319e236f8f87ab188f037435"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"f36af82b68522a203f90139fd866d6da6e1f6591","unresolved":false,"context_lines":[{"line_number":27,"context_line":"1. Use sentence style capitalization for the strings, this means: The"},{"line_number":28,"context_line":"   first character should be uppercase."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi line strings, add a space at the end of the line."},{"line_number":31,"context_line":""},{"line_number":32,"context_line":"3. Only use single spaces, no double spaces."},{"line_number":33,"context_line":""}],"source_content_type":"text/x-rst","patch_set":1,"id":"AAAAUH%2F%2BYN0%3D","line":30,"in_reply_to":"AAAAUH%2F%2BYOc%3D","updated":"2014-01-27 15:15:57.000000000","message":"Ok, will do.","commit_id":"ac764bc1a357ac37319e236f8f87ab188f037435"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"0cc9d72dba61a986e0a6d95ab122b3caf2c82e04","unresolved":false,"context_lines":[{"line_number":25,"context_line":"------------"},{"line_number":26,"context_line":""},{"line_number":27,"context_line":"1. Use sentence style capitalization for the strings, this means: The"},{"line_number":28,"context_line":"   first character should be uppercase."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi line strings, add a space at the end of the line."},{"line_number":31,"context_line":""}],"source_content_type":"text/x-rst","patch_set":2,"id":"AAAAUH%2F%2BYMQ%3D","line":28,"updated":"2014-01-27 15:21:15.000000000","message":"Consider this...\n\nUse sentence-style capitalization for strings: Capitalize or uppercase the first character.","commit_id":"6f9514e60f5e110a8d92cdf0db82c77d8c796cfb"},{"author":{"_account_id":2448,"name":"Diane Fleming","email":"dfleming@austin.rr.com","username":"diane-fleming"},"change_message_id":"18284c6eb3ef9cc1ce758d1bfedc459502645c2d","unresolved":false,"context_lines":[{"line_number":4,"context_line":""},{"line_number":5,"context_line":"This document describes some style guidelines for the help strings of"},{"line_number":6,"context_line":"config options. These help strings are a requirement for each option."},{"line_number":7,"context_line":"The help strings are not only used inside the code but also in the"},{"line_number":8,"context_line":"sample config files, like ``etc/cinder/cinder.conf``, and all of them are"},{"line_number":9,"context_line":"displayed in the `OpenStack Configuration Reference \u003chttp://docs.openstack.org/trunk/config-reference/content/index.html\u003e`_."},{"line_number":10,"context_line":""}],"source_content_type":"text/x-rst","patch_set":4,"id":"AAAAUH%2F%2BYCk%3D","line":7,"updated":"2014-01-27 15:45:52.000000000","message":"This document provides style guidance for writing the required help strings for configuration options in the xxx code.\n\nThe help strings are parsed from the code to appear in sample configuration files, such as xxx, in the xxx.","commit_id":"6c6283f2b03b3cc30a311c15d6360c91486bbf4c"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"472752e073188dffb4a19aeb8fee8bfc16c01a76","unresolved":false,"context_lines":[{"line_number":28,"context_line":"   uppercase the first character."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":31,"context_line":"   at the beginning. Example::"},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"     cfg.BoolOpt(\u0027glance_api_ssl_compression\u0027,"},{"line_number":34,"context_line":"                 default\u003dFalse,"}],"source_content_type":"text/x-rst","patch_set":4,"id":"AAAAUH%2F%2BYKs%3D","line":31,"updated":"2014-01-27 15:27:01.000000000","message":"Extra colon?","commit_id":"6c6283f2b03b3cc30a311c15d6360c91486bbf4c"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"129cbf445c74dc9c10233444832733e28808aaf3","unresolved":false,"context_lines":[{"line_number":28,"context_line":"   uppercase the first character."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":31,"context_line":"   at the beginning. Example::"},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"     cfg.BoolOpt(\u0027glance_api_ssl_compression\u0027,"},{"line_number":34,"context_line":"                 default\u003dFalse,"}],"source_content_type":"text/x-rst","patch_set":4,"id":"AAAAUH%2F%2BYH0%3D","line":31,"in_reply_to":"AAAAUH%2F%2BYKs%3D","updated":"2014-01-27 15:30:51.000000000","message":"That one is correct for ReStructured Text, the following paragraph is an example.","commit_id":"6c6283f2b03b3cc30a311c15d6360c91486bbf4c"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"526d11387022969d0a55b467574ff4cb97921f43","unresolved":false,"context_lines":[{"line_number":43,"context_line":""},{"line_number":44,"context_line":"3. Only use single spaces, no double spaces."},{"line_number":45,"context_line":""},{"line_number":46,"context_line":"4. Properly capitalize words, if in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."}],"source_content_type":"text/x-rst","patch_set":5,"id":"AAAAUH%2F%2BXbI%3D","line":46,"updated":"2014-01-27 17:18:54.000000000","message":"5. Use punctuation to end a sentence only if more than one sentence is created to describe the setting.\n\nExamples::\nhelp\u003d\u0027Allow the use of API extensions\u0027\n\nhelp\u003d\u0027Use H/A queues in RabbitMQ (x-ha-policy: all). \u0027\n        \u0027You need to wipe RabbitMQ database when \u0027\n        \u0027changing this option.\u0027","commit_id":"cf28a826e2644e53e958dc76ae6122e64dea3a64"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"446d404d0e985e83b37ca500ad0b2236cb1d0b97","unresolved":false,"context_lines":[{"line_number":28,"context_line":"------------"},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"1. Use sentence-style capitalization for strings: Capitalize or"},{"line_number":31,"context_line":"   uppercase the first character."},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":34,"context_line":"   at the beginning. Example::"}],"source_content_type":"text/x-rst","patch_set":6,"id":"AAAAUH%2F%2BXRA%3D","line":31,"updated":"2014-01-27 17:51:48.000000000","message":"Consider providing an example here too for consistency?","commit_id":"62669dd25bcdf86cfe60bf1f5c8b86b8c61f6d28"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"446d404d0e985e83b37ca500ad0b2236cb1d0b97","unresolved":false,"context_lines":[{"line_number":46,"context_line":"4. Properly capitalize words, if in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"5. Use punctuation to end a sentence only if more than one sentence is"},{"line_number":49,"context_line":"   created to describe the setting. "},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"    Examples::"},{"line_number":52,"context_line":"  "}],"source_content_type":"text/x-rst","patch_set":6,"id":"AAAAUH%2F%2BXRk%3D","line":49,"updated":"2014-01-27 17:51:48.000000000","message":"Trailing space.","commit_id":"62669dd25bcdf86cfe60bf1f5c8b86b8c61f6d28"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"446d404d0e985e83b37ca500ad0b2236cb1d0b97","unresolved":false,"context_lines":[{"line_number":48,"context_line":"5. Use punctuation to end a sentence only if more than one sentence is"},{"line_number":49,"context_line":"   created to describe the setting. "},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"    Examples::"},{"line_number":52,"context_line":"  "},{"line_number":53,"context_line":"      help\u003d\u0027Allow the use of API extensions\u0027"},{"line_number":54,"context_line":""}],"source_content_type":"text/x-rst","patch_set":6,"id":"AAAAUH%2F%2BXQg%3D","line":51,"updated":"2014-01-27 17:51:48.000000000","message":"Can you make the structure containing examples similar for each step?","commit_id":"62669dd25bcdf86cfe60bf1f5c8b86b8c61f6d28"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"446d404d0e985e83b37ca500ad0b2236cb1d0b97","unresolved":false,"context_lines":[{"line_number":49,"context_line":"   created to describe the setting. "},{"line_number":50,"context_line":""},{"line_number":51,"context_line":"    Examples::"},{"line_number":52,"context_line":"  "},{"line_number":53,"context_line":"      help\u003d\u0027Allow the use of API extensions\u0027"},{"line_number":54,"context_line":""},{"line_number":55,"context_line":"      help\u003d\u0027Use HAA queues in RabbitMQ (x-ha-policy: all). \u0027"}],"source_content_type":"text/x-rst","patch_set":6,"id":"AAAAUH%2F%2BXRw%3D","line":52,"updated":"2014-01-27 17:51:48.000000000","message":"Extra white space.","commit_id":"62669dd25bcdf86cfe60bf1f5c8b86b8c61f6d28"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"6bf5795880a3d144b7852c74136d49dc51ca6a2d","unresolved":false,"context_lines":[{"line_number":40,"context_line":""},{"line_number":41,"context_line":"3. Only use single spaces, no double spaces."},{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words, if in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. Use punctuation to end a sentence only if more than one sentence is"},{"line_number":46,"context_line":"   created to describe the setting."}],"source_content_type":"text/x-rst","patch_set":7,"id":"AAAAUH%2F%2BW7M%3D","line":43,"updated":"2014-01-27 18:40:30.000000000","message":"Consider a period rather than a comma here.","commit_id":"f301990884f3da764fbc25295fe1f0587bd06d1f"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"6bf5795880a3d144b7852c74136d49dc51ca6a2d","unresolved":false,"context_lines":[{"line_number":45,"context_line":"5. Use punctuation to end a sentence only if more than one sentence is"},{"line_number":46,"context_line":"   created to describe the setting."},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"    Examples::"},{"line_number":49,"context_line":""},{"line_number":50,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"},{"line_number":51,"context_line":"                default\u003dNone,"}],"source_content_type":"text/x-rst","patch_set":7,"id":"AAAAUH%2F%2BW70%3D","line":48,"updated":"2014-01-27 18:40:30.000000000","message":"I was also thinking about whether \"Examples::\" should come at the end of the sentence (step 2) or sit by itself (this step).","commit_id":"f301990884f3da764fbc25295fe1f0587bd06d1f"},{"author":{"_account_id":2448,"name":"Diane Fleming","email":"dfleming@austin.rr.com","username":"diane-fleming"},"change_message_id":"3977b23ff274692b0727652e075437f227fdb051","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. Use punctuation to end a sentence only if more than one sentence is"},{"line_number":46,"context_line":"   created to describe the setting. Examples::"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"}],"source_content_type":"text/x-rst","patch_set":8,"id":"AAAAUH%2F%2BWdo%3D","line":45,"updated":"2014-01-27 19:36:36.000000000","message":"I don\u0027t understand why you wouldn\u0027t use a period for help text that has one sentence?","commit_id":"945b5a6259a472892908ec880a50f35b5130577d"},{"author":{"_account_id":964,"name":"Anne Gentle","email":"annegentle@justwriteclick.com","username":"annegentle"},"change_message_id":"1017654e792eeb76b7902974c3391ccc3cc69050","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. Use punctuation to end a sentence only if more than one sentence is"},{"line_number":46,"context_line":"   created to describe the setting. Examples::"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"}],"source_content_type":"text/x-rst","patch_set":8,"id":"AAAAUH%2F%2BKtU%3D","line":45,"in_reply_to":"AAAAUH%2F%2BWdo%3D","updated":"2014-01-29 14:31:55.000000000","message":"Mostly because there are a lot edits we\u0027d have to do to bring it into compliance... number 5 reflects what I\u0027m seeing now. But if we\u0027re wanting improved text, maybe revise 5 to be:\n5. Write complete sentences and use punctuation so that you have a period at the end of each help description.","commit_id":"945b5a6259a472892908ec880a50f35b5130577d"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"1adadcbe56a655de1ea8295c41a4df18d19aeb73","unresolved":false,"context_lines":[{"line_number":46,"context_line":""},{"line_number":47,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"},{"line_number":48,"context_line":"                default\u003dNone,"},{"line_number":49,"context_line":"                help\u003d\u0027Base URL that appears in links to the OpenStack \u0027"},{"line_number":50,"context_line":"                     \u0027Block Storage API.\u0027)"},{"line_number":51,"context_line":""},{"line_number":52,"context_line":""}],"source_content_type":"text/x-rst","patch_set":10,"id":"AAAAUH%2F%2BJRY%3D","line":49,"updated":"2014-01-29 18:29:09.000000000","message":"Oddly, this isn\u0027t a complete sentence. Due to the nature of help strings, the subject is often implied and always using complete sentences may unnecessarily increase wordiness. However, we can still require use of periods.","commit_id":"4116db2cb797d374c8ea405529420c0b7dd9ef74"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"1adadcbe56a655de1ea8295c41a4df18d19aeb73","unresolved":false,"context_lines":[{"line_number":52,"context_line":""},{"line_number":53,"context_line":"     cfg.StrOpt(\u0027host\u0027,"},{"line_number":54,"context_line":"                default\u003dsocket.gethostname(),"},{"line_number":55,"context_line":"                help\u003d\u0027Name of this node. This can be an opaque identifier. \u0027"},{"line_number":56,"context_line":"                     \u0027It is not necessarily a host name, FQDN, or IP address.\u0027)"},{"line_number":57,"context_line":""}],"source_content_type":"text/x-rst","patch_set":10,"id":"AAAAUH%2F%2BJSg%3D","line":55,"updated":"2014-01-29 18:29:09.000000000","message":"Same issue here with the first string.","commit_id":"4116db2cb797d374c8ea405529420c0b7dd9ef74"},{"author":{"_account_id":9515,"name":"Matthew Kassawara","email":"mkassawara@gmail.com","username":"ionosphere80"},"change_message_id":"5a4f00ae5ff93b8056d59cdc4914914efd853a6e","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. Use punctuation to end a sentence and write complete sentences"},{"line_number":46,"context_line":"   if possible. Examples::"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"}],"source_content_type":"text/x-rst","patch_set":12,"id":"AAAAUH%2F%2BJNQ%3D","line":45,"updated":"2014-01-29 18:38:12.000000000","message":"How about... \"End each segment with a period and write complete sentences if possible.\"","commit_id":"9524a132cabae739977296621af99505cb1b009a"},{"author":{"_account_id":1849,"name":"Joe Gordon","email":"joe.gordon0@gmail.com","username":"jogo"},"change_message_id":"f7a3a0d307485b0fa241fd53501316a98edd1fb9","unresolved":false,"context_lines":[{"line_number":27,"context_line":"1. Use sentence-style capitalization for help strings: Capitalize or"},{"line_number":28,"context_line":"   uppercase the first character (see the examples above)."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":31,"context_line":"   at the beginning. Example::"},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"     cfg.BoolOpt(\u0027glance_api_ssl_compression\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9x0c%3D","line":30,"updated":"2014-02-04 02:08:20.000000000","message":"What is the goal of this document? To make sure we produce quality help messages? or to make sure the source code looks nice?\n\nWhile I agree with this one, I think this fits under the source code looks nice category and therefore doesn\u0027t belong here.","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"ef5c2bb11195c1f607d75bad25154fdaa8a42536","unresolved":false,"context_lines":[{"line_number":27,"context_line":"1. Use sentence-style capitalization for help strings: Capitalize or"},{"line_number":28,"context_line":"   uppercase the first character (see the examples above)."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":31,"context_line":"   at the beginning. Example::"},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"     cfg.BoolOpt(\u0027glance_api_ssl_compression\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9qf0%3D","line":30,"in_reply_to":"AAAAUH%2F9soY%3D","updated":"2014-02-05 08:14:55.000000000","message":"I\u0027ve moved this rule now to the end and gave it a header \"Format\" together and rephrased it as recommendation.","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"042d40517e4c3e23333f288de10ff071268e9e8f","unresolved":false,"context_lines":[{"line_number":27,"context_line":"1. Use sentence-style capitalization for help strings: Capitalize or"},{"line_number":28,"context_line":"   uppercase the first character (see the examples above)."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":31,"context_line":"   at the beginning. Example::"},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"     cfg.BoolOpt(\u0027glance_api_ssl_compression\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9xFU%3D","line":30,"in_reply_to":"AAAAUH%2F9x0c%3D","updated":"2014-02-04 06:40:48.000000000","message":"Write high quality help messages.\n\nYes, this is more source code looks nice - and also a reminder to add the space. I\u0027ve seen too many help strings with missed spaces. What about splitting this item out under a section Format?","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":1849,"name":"Joe Gordon","email":"joe.gordon0@gmail.com","username":"jogo"},"change_message_id":"c0470cff7cfaa4cef0d5ee361d5dddac836f6624","unresolved":false,"context_lines":[{"line_number":27,"context_line":"1. Use sentence-style capitalization for help strings: Capitalize or"},{"line_number":28,"context_line":"   uppercase the first character (see the examples above)."},{"line_number":29,"context_line":""},{"line_number":30,"context_line":"2. For multi-line strings, add a space at the end of the line and not"},{"line_number":31,"context_line":"   at the beginning. Example::"},{"line_number":32,"context_line":""},{"line_number":33,"context_line":"     cfg.BoolOpt(\u0027glance_api_ssl_compression\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9soY%3D","line":30,"in_reply_to":"AAAAUH%2F9xFU%3D","updated":"2014-02-04 21:29:38.000000000","message":"WhiIe I agree with this rule, I don\u0027t think this document should cover code formatting. Perhaps just a reminder about missed spaces.","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":1849,"name":"Joe Gordon","email":"joe.gordon0@gmail.com","username":"jogo"},"change_message_id":"f7a3a0d307485b0fa241fd53501316a98edd1fb9","unresolved":false,"context_lines":[{"line_number":38,"context_line":"                      \u0027network bandwidth is available and you use \u0027"},{"line_number":39,"context_line":"                      \u0027compressed image formats like qcow2.\u0027)"},{"line_number":40,"context_line":""},{"line_number":41,"context_line":"3. Only use single spaces, no double spaces."},{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9x00%3D","line":41,"updated":"2014-02-04 02:08:20.000000000","message":"we can write hacking rule for this.","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":1849,"name":"Joe Gordon","email":"joe.gordon0@gmail.com","username":"jogo"},"change_message_id":"f7a3a0d307485b0fa241fd53501316a98edd1fb9","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. End each segment with a period and write complete sentences if"},{"line_number":46,"context_line":"   possible. Examples::"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9x0s%3D","line":45,"updated":"2014-02-04 02:08:20.000000000","message":"when is it not possible to write a complete sentence?","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":6547,"name":"Andreas Jaeger","email":"jaegerandi@gmail.com","username":"jaegerandi"},"change_message_id":"042d40517e4c3e23333f288de10ff071268e9e8f","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. End each segment with a period and write complete sentences if"},{"line_number":46,"context_line":"   possible. Examples::"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9xE8%3D","line":45,"in_reply_to":"AAAAUH%2F9x0s%3D","updated":"2014-02-04 06:40:48.000000000","message":"It\u0027s always possible but not really needed in some cases. \"Name of this node.\" is acceptable IMHO.","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"},{"author":{"_account_id":1849,"name":"Joe Gordon","email":"joe.gordon0@gmail.com","username":"jogo"},"change_message_id":"c0470cff7cfaa4cef0d5ee361d5dddac836f6624","unresolved":false,"context_lines":[{"line_number":42,"context_line":""},{"line_number":43,"context_line":"4. Properly capitalize words. If in doubt check the `OpenStack Glossary \u003chttp://docs.openstack.org/glossary/\u003e`_."},{"line_number":44,"context_line":""},{"line_number":45,"context_line":"5. End each segment with a period and write complete sentences if"},{"line_number":46,"context_line":"   possible. Examples::"},{"line_number":47,"context_line":""},{"line_number":48,"context_line":"     cfg.StrOpt(\u0027osapi_volume_base_URL\u0027,"}],"source_content_type":"text/x-rst","patch_set":13,"id":"AAAAUH%2F9spI%3D","line":45,"in_reply_to":"AAAAUH%2F9xE8%3D","updated":"2014-02-04 21:29:38.000000000","message":"sounds reasonable.","commit_id":"889627a0c147266427b4acb1b65411269f74eb47"}]}