{"action":"created","issue":{"url":"https://api.github.com/repos/yamadapc/jsdoctest/issues/27","repository_url":"https://api.github.com/repos/yamadapc/jsdoctest","labels_url":"https://api.github.com/repos/yamadapc/jsdoctest/issues/27/labels{/name}","comments_url":"https://api.github.com/repos/yamadapc/jsdoctest/issues/27/comments","events_url":"https://api.github.com/repos/yamadapc/jsdoctest/issues/27/events","html_url":"https://github.com/yamadapc/jsdoctest/issues/27","id":158486093,"number":27,"title":"The comment parser should remove <caption>s","user":{"login":"stilist","id":33663,"avatar_url":"https://avatars.githubusercontent.com/u/33663?v=3","gravatar_id":"","url":"https://api.github.com/users/stilist","html_url":"https://github.com/stilist","followers_url":"https://api.github.com/users/stilist/followers","following_url":"https://api.github.com/users/stilist/following{/other_user}","gists_url":"https://api.github.com/users/stilist/gists{/gist_id}","starred_url":"https://api.github.com/users/stilist/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/stilist/subscriptions","organizations_url":"https://api.github.com/users/stilist/orgs","repos_url":"https://api.github.com/users/stilist/repos","events_url":"https://api.github.com/users/stilist/events{/privacy}","received_events_url":"https://api.github.com/users/stilist/received_events","type":"User","site_admin":false},"labels":[],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2016-06-04T04:03:37Z","updated_at":"2016-06-06T13:57:35Z","closed_at":"2016-06-06T13:49:20Z","body":"From the JSDoc [`@example` documentation](http://usejsdoc.org/tags-example.html):\r\n\r\n> Examples can also be captioned using `<caption></caption>` after the @example tag.\r\n>\r\n>     /**\r\n>      * Solves equations of the form a * x = b\r\n>      * @example <caption>Example usage of method1.</caption>\r\n>      * // returns 2\r\n>      * globalNS.method1(5, 10);\r\n>      * @returns {Number} Returns the value of x for the equation.\r\n>      */\r\n\r\njsdoctest doesn't recognize the `<caption>`, and generates `function` bodies that include the `<caption>` text.\r\n\r\n```shell\r\n$ cat lib/add.js\r\n/**\r\n * Adds two numbers\r\n * @example <caption>Test</caption>\r\n *    add(10, 20)\r\n *    // => 30\r\n */\r\nfunction add(x, y) {\r\n  return x + y;\r\n}\r\n\r\n$ \"$(npm bin)/jsdoctest\" --spec lib/add.js\r\nrequire('should');\r\n\r\ndescribe('lib/add', function() {\r\n      describe('add()', function() {\r\n            it('<caption>Test</caption>    add(10, 20)', function() {\r\n                  ( < caption > Test <\r\n                    /caption>    add(10, 20)).should.eql(30);});});});\r\n```\r\n"},"comment":{"url":"https://api.github.com/repos/yamadapc/jsdoctest/issues/comments/223966650","html_url":"https://github.com/yamadapc/jsdoctest/issues/27#issuecomment-223966650","issue_url":"https://api.github.com/repos/yamadapc/jsdoctest/issues/27","id":223966650,"user":{"login":"yamadapc","id":3923654,"avatar_url":"https://avatars.githubusercontent.com/u/3923654?v=3","gravatar_id":"","url":"https://api.github.com/users/yamadapc","html_url":"https://github.com/yamadapc","followers_url":"https://api.github.com/users/yamadapc/followers","following_url":"https://api.github.com/users/yamadapc/following{/other_user}","gists_url":"https://api.github.com/users/yamadapc/gists{/gist_id}","starred_url":"https://api.github.com/users/yamadapc/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/yamadapc/subscriptions","organizations_url":"https://api.github.com/users/yamadapc/orgs","repos_url":"https://api.github.com/users/yamadapc/repos","events_url":"https://api.github.com/users/yamadapc/events{/privacy}","received_events_url":"https://api.github.com/users/yamadapc/received_events","type":"User","site_admin":false},"created_at":"2016-06-06T13:57:35Z","updated_at":"2016-06-06T13:57:35Z","body":"Run `mocha --require . test/test-file-captioned.js` to see it happen."}}
{"actor":{"display_login":"yamadapc"}}