{"action":"opened","issue":{"url":"https://api.github.com/repos/rrrene/inch/issues/41","repository_url":"https://api.github.com/repos/rrrene/inch","labels_url":"https://api.github.com/repos/rrrene/inch/issues/41/labels{/name}","comments_url":"https://api.github.com/repos/rrrene/inch/issues/41/comments","events_url":"https://api.github.com/repos/rrrene/inch/issues/41/events","html_url":"https://github.com/rrrene/inch/issues/41","id":177957708,"number":41,"title":"Incorrect support for RDoc virtual methods","user":{"login":"halostatue","id":11361,"avatar_url":"https://avatars.githubusercontent.com/u/11361?v=3","gravatar_id":"","url":"https://api.github.com/users/halostatue","html_url":"https://github.com/halostatue","followers_url":"https://api.github.com/users/halostatue/followers","following_url":"https://api.github.com/users/halostatue/following{/other_user}","gists_url":"https://api.github.com/users/halostatue/gists{/gist_id}","starred_url":"https://api.github.com/users/halostatue/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/halostatue/subscriptions","organizations_url":"https://api.github.com/users/halostatue/orgs","repos_url":"https://api.github.com/users/halostatue/repos","events_url":"https://api.github.com/users/halostatue/events{/privacy}","received_events_url":"https://api.github.com/users/halostatue/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2016-09-20T03:55:19Z","updated_at":"2016-09-20T03:55:19Z","closed_at":null,"body":"Re: [U] [MIME::Type#preferred_extension](http://inch-ci.org/github/mime-types/ruby-mime-types/revision/b0a4457d/code_object/2645739?branch=qa-tool) in [mime-types/ruby-mime-types](http://inch-ci.org/github/mime-types/ruby-mime-types) Also probably related to #28 and #40.\r\n\r\nI’m not sure if you’ll be able to make this work properly since YARD deliberately does not support a number of RDoc features (including proper use of the `:nodoc:` directive, because it doesn’t believe gem authors are correct when they say `:nodoc:`), but most troublesome to me is its inability to support virtual method documentation. Inch reports that `MIME::Type#preferred_extension` is undocumented, which is *technically* correct, but with virtual method documentation it is incorrect.\r\n\r\nYou can see this throughout the mime-types code, but specifically at [lib/mime/type.rb:243-265](https://github.com/mime-types/ruby-mime-types/blob/qa-tool/lib/mime/type.rb#L243-L265). Here, I have specifically created a virtual method documentation for `attr_accessor :preferred_extension` and then I have implemented `preferred_extension` and `preferred_extension=`. The former I suppressed the documentation on; the latter I `:nodoc:`ed. YARD ignores everything here, and I suspect it causes inch to do the same.\r\n\r\nI do this because I want this documented as an `attr_accessor`, not as two methods (I realize that YARD doesn’t really distinguish between the two, but RDoc does and I like that).\r\n\r\nThanks for a great tool—I’m enjoying using it despite the problems I’m having getting it to recognize the documentation I have written, and I think it’s improving the documentation I have (which was pretty good to begin with, IMO)."}}
{"actor":{"display_login":"halostatue"}}