{"action":"created","issue":{"url":"https://api.github.com/repos/pythonnet/pythonnet/issues/374","repository_url":"https://api.github.com/repos/pythonnet/pythonnet","labels_url":"https://api.github.com/repos/pythonnet/pythonnet/issues/374/labels{/name}","comments_url":"https://api.github.com/repos/pythonnet/pythonnet/issues/374/comments","events_url":"https://api.github.com/repos/pythonnet/pythonnet/issues/374/events","html_url":"https://github.com/pythonnet/pythonnet/issues/374","id":206818030,"number":374,"title":"Enhancement to read XML doc strings from .NET libraries instead of just signature.","user":{"login":"lcorrigan","id":12451259,"avatar_url":"https://avatars.githubusercontent.com/u/12451259?v=3","gravatar_id":"","url":"https://api.github.com/users/lcorrigan","html_url":"https://github.com/lcorrigan","followers_url":"https://api.github.com/users/lcorrigan/followers","following_url":"https://api.github.com/users/lcorrigan/following{/other_user}","gists_url":"https://api.github.com/users/lcorrigan/gists{/gist_id}","starred_url":"https://api.github.com/users/lcorrigan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lcorrigan/subscriptions","organizations_url":"https://api.github.com/users/lcorrigan/orgs","repos_url":"https://api.github.com/users/lcorrigan/repos","events_url":"https://api.github.com/users/lcorrigan/events{/privacy}","received_events_url":"https://api.github.com/users/lcorrigan/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":4,"created_at":"2017-02-10T15:01:00Z","updated_at":"2017-02-14T13:42:01Z","closed_at":null,"body":"### Environment\r\n-   Pythonnet version: 2.2.2 \r\n-   Python version: 2.7.13 x86\r\n-   Operating System: Win10x64\r\n\r\n### Details\r\nVarious IDE's and Consoles (VS2015 with PTVS, Jupyter Notebook, ipython console etc) will show the function signature or class description within a .NET assembly for Intellisense/Autocompletion etc, but only the types are retrieved.  I believe pythonnet pulls this info from the [class | function].__doc__ field, as this is what shows up in the console/IDE for autocompletion.\r\nEx:\r\n```python\r\nimport clr\r\nclr.AddReference(\"System\")\r\nimport System\r\nimport System.Text\r\nprint System.Text.StringBuilder.__doc__\r\n```\r\n\r\n```\r\nVoid .ctor()\r\nVoid .ctor(Int32)\r\nVoid .ctor(Int32, Int32)\r\nVoid .ctor(System.String)\r\nVoid .ctor(System.String, Int32)\r\nVoid .ctor(System.String, Int32, Int32, Int32)\r\n```\r\n\r\nIt would be useful to be able to get more of what IronPython does, where it pulls the documentation for .NET libraries from the XML header (instead of the python docstring), which has much more detail on the parameters and saves you from looking up every class or function to get these details.\r\n\r\nEx:\r\n```python\r\nimport clr\r\nclr.AddReference(\"System\")\r\nimport System\r\nimport System.Text\r\nprint System.Text.StringBuilder.__doc__\r\n```\r\n\r\n```\r\nRepresents a mutable string of characters. This class cannot be inherited.\r\n\r\nStringBuilder()\r\nStringBuilder(capacity: int)\r\nStringBuilder(value: str)\r\nStringBuilder(value: str, capacity: int)\r\nStringBuilder(value: str, startIndex: int, length: int, capacity: int)\r\nStringBuilder(capacity: int, maxCapacity: int)\r\n```"},"comment":{"url":"https://api.github.com/repos/pythonnet/pythonnet/issues/comments/279709713","html_url":"https://github.com/pythonnet/pythonnet/issues/374#issuecomment-279709713","issue_url":"https://api.github.com/repos/pythonnet/pythonnet/issues/374","id":279709713,"user":{"login":"lcorrigan","id":12451259,"avatar_url":"https://avatars.githubusercontent.com/u/12451259?v=3","gravatar_id":"","url":"https://api.github.com/users/lcorrigan","html_url":"https://github.com/lcorrigan","followers_url":"https://api.github.com/users/lcorrigan/followers","following_url":"https://api.github.com/users/lcorrigan/following{/other_user}","gists_url":"https://api.github.com/users/lcorrigan/gists{/gist_id}","starred_url":"https://api.github.com/users/lcorrigan/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/lcorrigan/subscriptions","organizations_url":"https://api.github.com/users/lcorrigan/orgs","repos_url":"https://api.github.com/users/lcorrigan/repos","events_url":"https://api.github.com/users/lcorrigan/events{/privacy}","received_events_url":"https://api.github.com/users/lcorrigan/received_events","type":"User","site_admin":false},"created_at":"2017-02-14T13:42:01Z","updated_at":"2017-02-14T13:42:01Z","body":"Although it would be nice to have this feature for all .NET libraries, if it were limited to those assemblies that have accompanying XML help files it would be an awesome start. Our in-house libraries (large set) are created with Sandcastle XML documentation for a chm file already, so if pythonnet was able to read them for intellisense/autocompletion it would be great for rapid scripting. I appreciate the work you guys are doing on this."}}
{"actor":{"display_login":"lcorrigan"}}