{"action":"created","issue":{"url":"https://api.github.com/repos/google/auto/issues/291","labels_url":"https://api.github.com/repos/google/auto/issues/291/labels{/name}","comments_url":"https://api.github.com/repos/google/auto/issues/291/comments","events_url":"https://api.github.com/repos/google/auto/issues/291/events","html_url":"https://github.com/google/auto/issues/291","id":118507811,"number":291,"title":"Every generated file should include a URL for more information","user":{"login":"kevinb9n","id":934551,"avatar_url":"https://avatars.githubusercontent.com/u/934551?v=3","gravatar_id":"","url":"https://api.github.com/users/kevinb9n","html_url":"https://github.com/kevinb9n","followers_url":"https://api.github.com/users/kevinb9n/followers","following_url":"https://api.github.com/users/kevinb9n/following{/other_user}","gists_url":"https://api.github.com/users/kevinb9n/gists{/gist_id}","starred_url":"https://api.github.com/users/kevinb9n/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/kevinb9n/subscriptions","organizations_url":"https://api.github.com/users/kevinb9n/orgs","repos_url":"https://api.github.com/users/kevinb9n/repos","events_url":"https://api.github.com/users/kevinb9n/events{/privacy}","received_events_url":"https://api.github.com/users/kevinb9n/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":6,"created_at":"2015-11-24T00:51:04Z","updated_at":"2015-11-24T15:44:22Z","closed_at":null,"body":"It's important that anyone who comes across any generated file should be able to understand where it came from. imho, that means a URL reference.\r\n\r\n* For an AutoValue generated implementation, the URL should be https://github.com/google/auto/tree/master/value.\r\n\r\n* For a class generated by an AutoValue *extension*, the extension author should be compelled to supply this URL\r\n\r\n* (others can comment re: AutoFactory and others)\r\n\r\nOpen questions:\r\n\r\n* Should this URL simply be the content of @Generated? I think it should, and the current qualified class name we spit out is fairly useless. The fact that the @Generated annotation javadoc recommends FQCN as a convention matters basically not at all to me. The alternative is that we put this in a comment, which might as well be a javadoc comment (not that it seems remotely likely someone would be looking at generated javadoc for a generated class, but why not?)\r\n\r\n* If the generators can even spit out a *version*-specific URL that seems even cooler....\r\n"},"comment":{"url":"https://api.github.com/repos/google/auto/issues/comments/159308759","html_url":"https://github.com/google/auto/issues/291#issuecomment-159308759","issue_url":"https://api.github.com/repos/google/auto/issues/291","id":159308759,"user":{"login":"rharter","id":1296750,"avatar_url":"https://avatars.githubusercontent.com/u/1296750?v=3","gravatar_id":"","url":"https://api.github.com/users/rharter","html_url":"https://github.com/rharter","followers_url":"https://api.github.com/users/rharter/followers","following_url":"https://api.github.com/users/rharter/following{/other_user}","gists_url":"https://api.github.com/users/rharter/gists{/gist_id}","starred_url":"https://api.github.com/users/rharter/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/rharter/subscriptions","organizations_url":"https://api.github.com/users/rharter/orgs","repos_url":"https://api.github.com/users/rharter/repos","events_url":"https://api.github.com/users/rharter/events{/privacy}","received_events_url":"https://api.github.com/users/rharter/received_events","type":"User","site_admin":false},"created_at":"2015-11-24T15:44:22Z","updated_at":"2015-11-24T15:44:22Z","body":"Perhaps, in light of the convention and Javadoc around @Generated it makes sense to make the convention a link in the Javadocs of the generated classes, which would also fit the normal java conventions better.  "}}