{"action":"created","issue":{"url":"https://api.github.com/repos/lsegal/yard/issues/833","labels_url":"https://api.github.com/repos/lsegal/yard/issues/833/labels{/name}","comments_url":"https://api.github.com/repos/lsegal/yard/issues/833/comments","events_url":"https://api.github.com/repos/lsegal/yard/issues/833/events","html_url":"https://github.com/lsegal/yard/issues/833","id":54464265,"number":833,"title":"@param example is confusing","user":{"login":"kwinters","id":384067,"avatar_url":"https://avatars.githubusercontent.com/u/384067?v=3","gravatar_id":"","url":"https://api.github.com/users/kwinters","html_url":"https://github.com/kwinters","followers_url":"https://api.github.com/users/kwinters/followers","following_url":"https://api.github.com/users/kwinters/following{/other_user}","gists_url":"https://api.github.com/users/kwinters/gists{/gist_id}","starred_url":"https://api.github.com/users/kwinters/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kwinters/subscriptions","organizations_url":"https://api.github.com/users/kwinters/orgs","repos_url":"https://api.github.com/users/kwinters/repos","events_url":"https://api.github.com/users/kwinters/events{/privacy}","received_events_url":"https://api.github.com/users/kwinters/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":3,"created_at":"2015-01-15T15:46:57Z","updated_at":"2015-10-20T22:15:53Z","closed_at":"2015-02-21T21:04:40Z","body":"See lib/yard/tags/library.rb @param section.\r\n\r\n\"Documents a single method parameter with a given name, type and optional description.\"\r\n\r\nBut the example is \"@param [String] the URL of the page to download\" which omits the required(?) name of the param.\r\n\r\nSo I suggest adding an example that includes the param name. If the name is supposed to be optional, please also update the docs to say so or remove the example that omits it."},"comment":{"url":"https://api.github.com/repos/lsegal/yard/issues/comments/149718303","html_url":"https://github.com/lsegal/yard/issues/833#issuecomment-149718303","issue_url":"https://api.github.com/repos/lsegal/yard/issues/833","id":149718303,"user":{"login":"lsegal","id":686,"avatar_url":"https://avatars.githubusercontent.com/u/686?v=3","gravatar_id":"","url":"https://api.github.com/users/lsegal","html_url":"https://github.com/lsegal","followers_url":"https://api.github.com/users/lsegal/followers","following_url":"https://api.github.com/users/lsegal/following{/other_user}","gists_url":"https://api.github.com/users/lsegal/gists{/gist_id}","starred_url":"https://api.github.com/users/lsegal/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lsegal/subscriptions","organizations_url":"https://api.github.com/users/lsegal/orgs","repos_url":"https://api.github.com/users/lsegal/repos","events_url":"https://api.github.com/users/lsegal/events{/privacy}","received_events_url":"https://api.github.com/users/lsegal/received_events","type":"User","site_admin":false},"created_at":"2015-10-20T22:15:53Z","updated_at":"2015-10-20T22:15:53Z","body":"@GuyPaddock neither form is wrong since both are valid and supported. If you want to make a *pull request* to consolidate the syntax of examples I'd be okay with it, but an issue won't be looked at without an accompanying PR."}}