{"action":"created","issue":{"url":"https://api.github.com/repos/nim-lang/Nim/issues/3118","labels_url":"https://api.github.com/repos/nim-lang/Nim/issues/3118/labels{/name}","comments_url":"https://api.github.com/repos/nim-lang/Nim/issues/3118/comments","events_url":"https://api.github.com/repos/nim-lang/Nim/issues/3118/events","html_url":"https://github.com/nim-lang/Nim/pull/3118","id":95050952,"number":3118,"title":"Added Documentation Style Guide; Fixes #3089","user":{"login":"apense","id":10226339,"avatar_url":"https://avatars.githubusercontent.com/u/10226339?v=3","gravatar_id":"","url":"https://api.github.com/users/apense","html_url":"https://github.com/apense","followers_url":"https://api.github.com/users/apense/followers","following_url":"https://api.github.com/users/apense/following{/other_user}","gists_url":"https://api.github.com/users/apense/gists{/gist_id}","starred_url":"https://api.github.com/users/apense/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apense/subscriptions","organizations_url":"https://api.github.com/users/apense/orgs","repos_url":"https://api.github.com/users/apense/repos","events_url":"https://api.github.com/users/apense/events{/privacy}","received_events_url":"https://api.github.com/users/apense/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":9,"created_at":"2015-07-14T21:54:08Z","updated_at":"2015-07-17T00:43:33Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/nim-lang/Nim/pulls/3118","html_url":"https://github.com/nim-lang/Nim/pull/3118","diff_url":"https://github.com/nim-lang/Nim/pull/3118.diff","patch_url":"https://github.com/nim-lang/Nim/pull/3118.patch"},"body":"Added link to it from contributing.rst"},"comment":{"url":"https://api.github.com/repos/nim-lang/Nim/issues/comments/122138109","html_url":"https://github.com/nim-lang/Nim/pull/3118#issuecomment-122138109","issue_url":"https://api.github.com/repos/nim-lang/Nim/issues/3118","id":122138109,"user":{"login":"apense","id":10226339,"avatar_url":"https://avatars.githubusercontent.com/u/10226339?v=3","gravatar_id":"","url":"https://api.github.com/users/apense","html_url":"https://github.com/apense","followers_url":"https://api.github.com/users/apense/followers","following_url":"https://api.github.com/users/apense/following{/other_user}","gists_url":"https://api.github.com/users/apense/gists{/gist_id}","starred_url":"https://api.github.com/users/apense/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/apense/subscriptions","organizations_url":"https://api.github.com/users/apense/orgs","repos_url":"https://api.github.com/users/apense/repos","events_url":"https://api.github.com/users/apense/events{/privacy}","received_events_url":"https://api.github.com/users/apense/received_events","type":"User","site_admin":false},"created_at":"2015-07-17T00:43:33Z","updated_at":"2015-07-17T00:43:33Z","body":"@ReneSac I understand, but when there's only one clause, it tends to be dependent and looks a little weird with a period.\r\n\r\n```nim\r\nproc sayHello*(): string =\r\n  ## Says hello\r\nproc giveFivePi*(): float =\r\n  ## Computes the value of pi to five decimal places\r\n```\r\n```nim\r\nproc sayHello*(): string =\r\n  ## Says hello.\r\nproc giveFivePi*(): float =\r\n  ## Computes the value of pi to five decimal places.\r\n```\r\n\r\nI think either is OK, but it seems like the discussion at #3089 didn't prefer a period at the end when the sentence is imcomplete (only should happen if the entire documentation is a sentence fragment). Maybe I'm imagining that. \r\nNot having a period after a beginning fragment seems to make a compromise between forcing full sentences and allowing the proc name to be part of the documentation."}}