{"action":"created","issue":{"url":"https://api.github.com/repos/joyent/node/issues/9313","labels_url":"https://api.github.com/repos/joyent/node/issues/9313/labels{/name}","comments_url":"https://api.github.com/repos/joyent/node/issues/9313/comments","events_url":"https://api.github.com/repos/joyent/node/issues/9313/events","html_url":"https://github.com/joyent/node/issues/9313","id":59448196,"number":9313,"title":"Return value of fs.unlinkSync not documented","user":{"login":"binarykitchen","id":177641,"avatar_url":"https://avatars.githubusercontent.com/u/177641?v=3","gravatar_id":"","url":"https://api.github.com/users/binarykitchen","html_url":"https://github.com/binarykitchen","followers_url":"https://api.github.com/users/binarykitchen/followers","following_url":"https://api.github.com/users/binarykitchen/following{/other_user}","gists_url":"https://api.github.com/users/binarykitchen/gists{/gist_id}","starred_url":"https://api.github.com/users/binarykitchen/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/binarykitchen/subscriptions","organizations_url":"https://api.github.com/users/binarykitchen/orgs","repos_url":"https://api.github.com/users/binarykitchen/repos","events_url":"https://api.github.com/users/binarykitchen/events{/privacy}","received_events_url":"https://api.github.com/users/binarykitchen/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/joyent/node/labels/doc","name":"doc","color":"944008"},{"url":"https://api.github.com/repos/joyent/node/labels/easy","name":"easy","color":"02e10c"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":9,"created_at":"2015-03-02T07:40:19Z","updated_at":"2015-03-07T02:38:04Z","closed_at":null,"body":"Somehow http://nodejs.org/api/fs.html#fs_fs_unlinksync_path does not tell what it's return value is. I'd like to know it. Would be good to add this on that page.\r\n\r\nThanks!"},"comment":{"url":"https://api.github.com/repos/joyent/node/issues/comments/77668980","html_url":"https://github.com/joyent/node/issues/9313#issuecomment-77668980","issue_url":"https://api.github.com/repos/joyent/node/issues/9313","id":77668980,"user":{"login":"misterdjules","id":811047,"avatar_url":"https://avatars.githubusercontent.com/u/811047?v=3","gravatar_id":"","url":"https://api.github.com/users/misterdjules","html_url":"https://github.com/misterdjules","followers_url":"https://api.github.com/users/misterdjules/followers","following_url":"https://api.github.com/users/misterdjules/following{/other_user}","gists_url":"https://api.github.com/users/misterdjules/gists{/gist_id}","starred_url":"https://api.github.com/users/misterdjules/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/misterdjules/subscriptions","organizations_url":"https://api.github.com/users/misterdjules/orgs","repos_url":"https://api.github.com/users/misterdjules/repos","events_url":"https://api.github.com/users/misterdjules/events{/privacy}","received_events_url":"https://api.github.com/users/misterdjules/received_events","type":"User","site_admin":false},"created_at":"2015-03-07T02:38:04Z","updated_at":"2015-03-07T02:38:04Z","body":"@tyleranton That's great! \r\n\r\nPlease not however that I do not agree anymore with what I said [in my previous comment](https://github.com/joyent/node/issues/9313#issuecomment-76874074) :)\r\n\r\nBasically, I think that instead of mentioning in the introduction that \"all functions for which the returned value is not mentioned return undefined\", I think we sould mention the return value in each function's documentation section.\r\n\r\nThe reason for that is that users can jump to specific functions in the documentation without reading the introduction (it's an API documentation, not a tutorial), and thus they would miss this information.\r\n\r\nSo my suggestion would be, depending on the time you have, to either just fix the documentation for `fs.unlinkSync` by adding that it returns undefined, or if you have more time to fix that for every synchronous function of the `fs` module that returns `undefined`.\r\n\r\nDoes that make sense? @joyent/node-coreteam What do you think?\r\n\r\nIf you need help with any of this, I can help you in #libuv on Freenode (my nickname is jgi), or here on GitHub.\r\n\r\nThank you!"}}