{"action":"created","issue":{"url":"https://api.github.com/repos/googleapis/toolkit/issues/252","repository_url":"https://api.github.com/repos/googleapis/toolkit","labels_url":"https://api.github.com/repos/googleapis/toolkit/issues/252/labels{/name}","comments_url":"https://api.github.com/repos/googleapis/toolkit/issues/252/comments","events_url":"https://api.github.com/repos/googleapis/toolkit/issues/252/events","html_url":"https://github.com/googleapis/toolkit/issues/252","id":160949298,"number":252,"title":"[Python] Generate default class docstring when needed","user":{"login":"bjwatson","id":471755,"avatar_url":"https://avatars.githubusercontent.com/u/471755?v=3","gravatar_id":"","url":"https://api.github.com/users/bjwatson","html_url":"https://github.com/bjwatson","followers_url":"https://api.github.com/users/bjwatson/followers","following_url":"https://api.github.com/users/bjwatson/following{/other_user}","gists_url":"https://api.github.com/users/bjwatson/gists{/gist_id}","starred_url":"https://api.github.com/users/bjwatson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bjwatson/subscriptions","organizations_url":"https://api.github.com/users/bjwatson/orgs","repos_url":"https://api.github.com/users/bjwatson/repos","events_url":"https://api.github.com/users/bjwatson/events{/privacy}","received_events_url":"https://api.github.com/users/bjwatson/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/googleapis/toolkit/labels/enhancement","name":"enhancement","color":"84b6eb"},{"url":"https://api.github.com/repos/googleapis/toolkit/labels/Python","name":"Python","color":"5319e7"}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":2,"created_at":"2016-06-17T18:34:12Z","updated_at":"2016-07-27T17:05:28Z","closed_at":null,"body":"If a class docstring does not exist, then Sphinx will not generate a documentation page for that class. Arguably this is a bug in Sphinx, but it's one we need to work around.\r\n\r\nThis happens for us when the proto file does not have a comment describing the service. One example is `logging_config.proto` and `logging_metrics.proto` for the Logging API. I added service level comments in the https://github.com/googleapis/googleapis repo, but the upstream source does not have them.\r\n\r\nWe should enhance our surface generator to be robust about this, and generate a default docstring when the service does not have a comment. We should also emit a warning in the generator output."},"comment":{"url":"https://api.github.com/repos/googleapis/toolkit/issues/comments/235652157","html_url":"https://github.com/googleapis/toolkit/issues/252#issuecomment-235652157","issue_url":"https://api.github.com/repos/googleapis/toolkit/issues/252","id":235652157,"user":{"login":"bjwatson","id":471755,"avatar_url":"https://avatars.githubusercontent.com/u/471755?v=3","gravatar_id":"","url":"https://api.github.com/users/bjwatson","html_url":"https://github.com/bjwatson","followers_url":"https://api.github.com/users/bjwatson/followers","following_url":"https://api.github.com/users/bjwatson/following{/other_user}","gists_url":"https://api.github.com/users/bjwatson/gists{/gist_id}","starred_url":"https://api.github.com/users/bjwatson/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/bjwatson/subscriptions","organizations_url":"https://api.github.com/users/bjwatson/orgs","repos_url":"https://api.github.com/users/bjwatson/repos","events_url":"https://api.github.com/users/bjwatson/events{/privacy}","received_events_url":"https://api.github.com/users/bjwatson/received_events","type":"User","site_admin":false},"created_at":"2016-07-27T17:05:28Z","updated_at":"2016-07-27T17:05:28Z","body":"We should also file a bug with the Sphinx project about this, if they don't already have one."}}
{"actor":{"display_login":"bjwatson"}}