{"action":"opened","issue":{"url":"https://api.github.com/repos/cta-observatory/ctapipe/issues/832","repository_url":"https://api.github.com/repos/cta-observatory/ctapipe","labels_url":"https://api.github.com/repos/cta-observatory/ctapipe/issues/832/labels{/name}","comments_url":"https://api.github.com/repos/cta-observatory/ctapipe/issues/832/comments","events_url":"https://api.github.com/repos/cta-observatory/ctapipe/issues/832/events","html_url":"https://github.com/cta-observatory/ctapipe/issues/832","id":383524836,"node_id":"MDU6SXNzdWUzODM1MjQ4MzY=","number":832,"title":"Could Tool use __doc__ to create description?","user":{"login":"dneise","id":8200858,"node_id":"MDQ6VXNlcjgyMDA4NTg=","avatar_url":"https://avatars2.githubusercontent.com/u/8200858?v=4","gravatar_id":"","url":"https://api.github.com/users/dneise","html_url":"https://github.com/dneise","followers_url":"https://api.github.com/users/dneise/followers","following_url":"https://api.github.com/users/dneise/following{/other_user}","gists_url":"https://api.github.com/users/dneise/gists{/gist_id}","starred_url":"https://api.github.com/users/dneise/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dneise/subscriptions","organizations_url":"https://api.github.com/users/dneise/orgs","repos_url":"https://api.github.com/users/dneise/repos","events_url":"https://api.github.com/users/dneise/events{/privacy}","received_events_url":"https://api.github.com/users/dneise/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2018-11-22T12:57:30Z","updated_at":"2018-11-22T12:57:30Z","closed_at":null,"author_association":"CONTRIBUTOR","body":"This issue similar to #831.\r\n\r\nI'd like to spare all of us the time of explaining in great detail why I believe `descripiton` might be confusing since `__doc__` already exists, but in many tools I have seen, the classes docstrings where not used to document the class, instead description was used.\r\n\r\nI wonder, could we do this ... \r\n```python\r\nclass Tool(Application): \r\n    def __init__(self, *args, **kwargs): \r\n        self.name = self.__class__.__doc__ \r\n        super().__init__(*args, **kwargs) \r\n``` \r\n... and then devs can do the very natural ...\r\n```python\r\nclass MyTool(Tool):\r\n    \"\"\"MyTools Description\"\"\"\r\n    pass\r\n\r\ntool = MyTool()\r\nprint(tool.description)   # --> \"MyTools Description\"\r\n```\r\n... and we have nicely decoupled the strange behaviour of traitlets? "}}
{"actor":{"display_login":"dneise"}}