{"action":"created","issue":{"url":"https://api.github.com/repos/derekwyatt/vim-scala/issues/86","labels_url":"https://api.github.com/repos/derekwyatt/vim-scala/issues/86/labels{/name}","comments_url":"https://api.github.com/repos/derekwyatt/vim-scala/issues/86/comments","events_url":"https://api.github.com/repos/derekwyatt/vim-scala/issues/86/events","html_url":"https://github.com/derekwyatt/vim-scala/pull/86","id":55750418,"number":86,"title":"Set value for the 'comments' option","user":{"login":"ches","id":13277,"avatar_url":"https://avatars.githubusercontent.com/u/13277?v=3","gravatar_id":"","url":"https://api.github.com/users/ches","html_url":"https://github.com/ches","followers_url":"https://api.github.com/users/ches/followers","following_url":"https://api.github.com/users/ches/following{/other_user}","gists_url":"https://api.github.com/users/ches/gists{/gist_id}","starred_url":"https://api.github.com/users/ches/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ches/subscriptions","organizations_url":"https://api.github.com/users/ches/orgs","repos_url":"https://api.github.com/users/ches/repos","events_url":"https://api.github.com/users/ches/events{/privacy}","received_events_url":"https://api.github.com/users/ches/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-01-28T12:29:39Z","updated_at":"2015-01-28T14:26:36Z","closed_at":"2015-01-28T14:26:33Z","pull_request":{"url":"https://api.github.com/repos/derekwyatt/vim-scala/pulls/86","html_url":"https://github.com/derekwyatt/vim-scala/pull/86","diff_url":"https://github.com/derekwyatt/vim-scala/pull/86.diff","patch_url":"https://github.com/derekwyatt/vim-scala/pull/86.patch"},"body":"Vim's default value for this option is `s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-`, which you just have to read `:help 'comments'` to make any sense of, but it's basically a \"try to do the right thing for a wide range of possible file types\" compromise. In particular, `b:#` means \"hash is a comment if followed by whitespace, so not e.g. `#define` in a C-like\". Another plugin I use (perhaps dubiously) got a little tripped up by this, thinking it was an indication that `#` is a valid comment leader in Scala.\r\n\r\nThis change sets the option to the same value as in the core c.vim runtime files, with one addition: the explicit start/middle/end trio for `/**`. Without this, it was wrapping text onto the `/**` opening line when formatting with `gq`.\r\n\r\nIn general this follows traditional Javadoc style. I know [there are Scaladoc style suggestions][1] about how the stars should align differently (heh), but I've never heard a convincing argument for that convention and *have* seen (unexplained) disagreement among people who get to publish those things, so that probably explains why most of the community seems to ignore it and stick to the Java way. Anyone who feels strongly about the blessed Scaladoc style can always tweak the setting with their own autocommand, `after/ftplugin`, project-local vimrc, or whatever.\r\n\r\nThe first start/middle/end trio keeps bulleted list items with dashes from getting munged together by `gq` formatting inside comments. It'd be cool if `{{{` code blocks and even Scaladoc ordered list syntax could be supported this way too, but the `comments` option doesn't seem to be a sharp enough tool to handle those cleanly or at all.\r\n\r\n[1]: http://docs.scala-lang.org/style/scaladoc.html"},"comment":{"url":"https://api.github.com/repos/derekwyatt/vim-scala/issues/comments/71842345","html_url":"https://github.com/derekwyatt/vim-scala/pull/86#issuecomment-71842345","issue_url":"https://api.github.com/repos/derekwyatt/vim-scala/issues/86","id":71842345,"user":{"login":"derekwyatt","id":62324,"avatar_url":"https://avatars.githubusercontent.com/u/62324?v=3","gravatar_id":"","url":"https://api.github.com/users/derekwyatt","html_url":"https://github.com/derekwyatt","followers_url":"https://api.github.com/users/derekwyatt/followers","following_url":"https://api.github.com/users/derekwyatt/following{/other_user}","gists_url":"https://api.github.com/users/derekwyatt/gists{/gist_id}","starred_url":"https://api.github.com/users/derekwyatt/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/derekwyatt/subscriptions","organizations_url":"https://api.github.com/users/derekwyatt/orgs","repos_url":"https://api.github.com/users/derekwyatt/repos","events_url":"https://api.github.com/users/derekwyatt/events{/privacy}","received_events_url":"https://api.github.com/users/derekwyatt/received_events","type":"User","site_admin":false},"created_at":"2015-01-28T14:26:36Z","updated_at":"2015-01-28T14:26:36Z","body":"Looks OK to me.  Thanks."}}