{"action":"created","issue":{"url":"https://api.github.com/repos/manastech/crystal/issues/1667","labels_url":"https://api.github.com/repos/manastech/crystal/issues/1667/labels{/name}","comments_url":"https://api.github.com/repos/manastech/crystal/issues/1667/comments","events_url":"https://api.github.com/repos/manastech/crystal/issues/1667/events","html_url":"https://github.com/manastech/crystal/pull/1667","id":109359381,"number":1667,"title":"Add simple style guide to docs","user":{"login":"rmosolgo","id":2231765,"avatar_url":"https://avatars.githubusercontent.com/u/2231765?v=3","gravatar_id":"","url":"https://api.github.com/users/rmosolgo","html_url":"https://github.com/rmosolgo","followers_url":"https://api.github.com/users/rmosolgo/followers","following_url":"https://api.github.com/users/rmosolgo/following{/other_user}","gists_url":"https://api.github.com/users/rmosolgo/gists{/gist_id}","starred_url":"https://api.github.com/users/rmosolgo/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rmosolgo/subscriptions","organizations_url":"https://api.github.com/users/rmosolgo/orgs","repos_url":"https://api.github.com/users/rmosolgo/repos","events_url":"https://api.github.com/users/rmosolgo/events{/privacy}","received_events_url":"https://api.github.com/users/rmosolgo/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-10-01T18:45:28Z","updated_at":"2015-10-01T19:40:03Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/manastech/crystal/pulls/1667","html_url":"https://github.com/manastech/crystal/pull/1667","diff_url":"https://github.com/manastech/crystal/pull/1667.diff","patch_url":"https://github.com/manastech/crystal/pull/1667.patch"},"body":"- Add a \"Conventions\" section \r\n- Move \"Documenting code\" to that section \r\n- Add a simple style guide \r\n\r\n![image](https://cloud.githubusercontent.com/assets/2231765/10230100/541fca60-6830-11e5-9572-489c07718e16.png)\r\n\r\nThis was heavily discussed here: https://github.com/manastech/crystal/issues/1616 As described there, I think a forced coding style is no-good. It adds overhead to simple tasks.\r\n\r\nAn external formatter tool was also discussed, but pushed off until after 1.0, which seems wise: https://github.com/manastech/crystal/issues/309\r\n\r\nI suggest a very minimal style guide. I know there are many things that people disagree on, and I have tried to leave those out. Instead, I have identified (or tried to identify) things that are widely present in the standard library (showing a Ruby influence, I think).\r\n\r\n(This PR was triggered by a code sample from someone following a Java example: http://play.crystal-lang.org/#/r/hqg.)\r\n\r\nSo, what do you think? Is this a good solution to this issue? Is this style guide sufficient? \r\n\r\n\r\n\r\n"},"comment":{"url":"https://api.github.com/repos/manastech/crystal/issues/comments/144825822","html_url":"https://github.com/manastech/crystal/pull/1667#issuecomment-144825822","issue_url":"https://api.github.com/repos/manastech/crystal/issues/1667","id":144825822,"user":{"login":"ysbaddaden","id":47380,"avatar_url":"https://avatars.githubusercontent.com/u/47380?v=3","gravatar_id":"","url":"https://api.github.com/users/ysbaddaden","html_url":"https://github.com/ysbaddaden","followers_url":"https://api.github.com/users/ysbaddaden/followers","following_url":"https://api.github.com/users/ysbaddaden/following{/other_user}","gists_url":"https://api.github.com/users/ysbaddaden/gists{/gist_id}","starred_url":"https://api.github.com/users/ysbaddaden/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ysbaddaden/subscriptions","organizations_url":"https://api.github.com/users/ysbaddaden/orgs","repos_url":"https://api.github.com/users/ysbaddaden/repos","events_url":"https://api.github.com/users/ysbaddaden/events{/privacy}","received_events_url":"https://api.github.com/users/ysbaddaden/received_events","type":"User","site_admin":false},"created_at":"2015-10-01T19:40:03Z","updated_at":"2015-10-01T19:40:03Z","body":":+1: for me. Maybe just add the `Lib` prefix as suggested by @jhass."}}