{"action":"created","issue":{"url":"https://api.github.com/repos/sphinx-doc/testing2/issues/311","labels_url":"https://api.github.com/repos/sphinx-doc/testing2/issues/311/labels{/name}","comments_url":"https://api.github.com/repos/sphinx-doc/testing2/issues/311/comments","events_url":"https://api.github.com/repos/sphinx-doc/testing2/issues/311/events","html_url":"https://github.com/sphinx-doc/testing2/issues/311","id":53262011,"number":311,"title":":type: for ivar, cvar...","user":{"login":"shimizukawa","id":151623,"avatar_url":"https://avatars.githubusercontent.com/u/151623?v=3","gravatar_id":"","url":"https://api.github.com/users/shimizukawa","html_url":"https://github.com/shimizukawa","followers_url":"https://api.github.com/users/shimizukawa/followers","following_url":"https://api.github.com/users/shimizukawa/following{/other_user}","gists_url":"https://api.github.com/users/shimizukawa/gists{/gist_id}","starred_url":"https://api.github.com/users/shimizukawa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shimizukawa/subscriptions","organizations_url":"https://api.github.com/users/shimizukawa/orgs","repos_url":"https://api.github.com/users/shimizukawa/repos","events_url":"https://api.github.com/users/shimizukawa/events{/privacy}","received_events_url":"https://api.github.com/users/shimizukawa/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/sphinx-doc/testing2/labels/bug","name":"bug","color":"fc2929"},{"url":"https://api.github.com/repos/sphinx-doc/testing2/labels/invalid","name":"invalid","color":"e6e6e6"}],"state":"closed","locked":false,"assignee":null,"milestone":null,"comments":2,"created_at":"2015-01-02T16:35:32Z","updated_at":"2015-01-02T16:35:35Z","closed_at":"2015-01-02T16:35:33Z","body":"Sphinx seems to be missing :type: for ivars and cvars, and module level variables / constants.\n\nFor example module level variable:\n    \n    #!python\n    PARSE_ALL_CHUNK_SIZE = 153600\n    \"\"\"Chunk size of parsing all frames.\n    \n    :type: int\"\"\"\n    \n\nand for example instance variables, following is using the \"new\" syntax for documenting instance variables:\n    \n    #!python\n    class Foo(object):\n        \"\"\"Awesome Foo\"\"\"\n        def __init__(self):\n            \"\"\"Create Foo\"\"\"\n            \n            self.bar = \"Something\"\n            \"\"\"Bar is cool?\n            \n            :type: string, or None\n            \"\"\"\n            # ...\n    \n\nEspecially for people coming EpyDoc this would make perfect sense, since in EpyDoc those works just like written above (with @-sign of-course)\n\nWhy do I think variables //needs// type information? They always doesn't, but I think for example in above case when instance variable can be None **or** string, it would be nice to be able to tell it through documentation so the user of the API won't assume it is always string, that might lead to fragile code when None's are not checked...\n\n----------------------------------------\n- Bitbucket: https://bitbucket.org/birkenfeld/sphinx/issue/311\n- Originally reported by: [ciantic](https://bitbucket.org/ciantic)\n- Originally created at: 2010-01-09T19:05:22.770\n"},"comment":{"url":"https://api.github.com/repos/sphinx-doc/testing2/issues/comments/68539952","html_url":"https://github.com/sphinx-doc/testing2/issues/311#issuecomment-68539952","issue_url":"https://api.github.com/repos/sphinx-doc/testing2/issues/311","id":68539952,"user":{"login":"shimizukawa","id":151623,"avatar_url":"https://avatars.githubusercontent.com/u/151623?v=3","gravatar_id":"","url":"https://api.github.com/users/shimizukawa","html_url":"https://github.com/shimizukawa","followers_url":"https://api.github.com/users/shimizukawa/followers","following_url":"https://api.github.com/users/shimizukawa/following{/other_user}","gists_url":"https://api.github.com/users/shimizukawa/gists{/gist_id}","starred_url":"https://api.github.com/users/shimizukawa/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/shimizukawa/subscriptions","organizations_url":"https://api.github.com/users/shimizukawa/orgs","repos_url":"https://api.github.com/users/shimizukawa/repos","events_url":"https://api.github.com/users/shimizukawa/events{/privacy}","received_events_url":"https://api.github.com/users/shimizukawa/received_events","type":"User","site_admin":false},"created_at":"2015-01-02T16:35:35Z","updated_at":"2015-01-02T16:35:35Z","body":"_From Georg Brandl on 2013-03-31 13:57:34+00:00_\n\nRemoving version: 0.6.3 (automated comment)"}}