{"action":"created","issue":{"url":"https://api.github.com/repos/scipy/scipy/issues/6762","repository_url":"https://api.github.com/repos/scipy/scipy","labels_url":"https://api.github.com/repos/scipy/scipy/issues/6762/labels{/name}","comments_url":"https://api.github.com/repos/scipy/scipy/issues/6762/comments","events_url":"https://api.github.com/repos/scipy/scipy/issues/6762/events","html_url":"https://github.com/scipy/scipy/pull/6762","id":187512225,"number":6762,"title":"DOC: Improve docstrings of sparse matrices","user":{"login":"nmayorov","id":7074023,"avatar_url":"https://avatars.githubusercontent.com/u/7074023?v=3","gravatar_id":"","url":"https://api.github.com/users/nmayorov","html_url":"https://github.com/nmayorov","followers_url":"https://api.github.com/users/nmayorov/followers","following_url":"https://api.github.com/users/nmayorov/following{/other_user}","gists_url":"https://api.github.com/users/nmayorov/gists{/gist_id}","starred_url":"https://api.github.com/users/nmayorov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nmayorov/subscriptions","organizations_url":"https://api.github.com/users/nmayorov/orgs","repos_url":"https://api.github.com/users/nmayorov/repos","events_url":"https://api.github.com/users/nmayorov/events{/privacy}","received_events_url":"https://api.github.com/users/nmayorov/received_events","type":"User","site_admin":false},"labels":[{"id":37345775,"url":"https://api.github.com/repos/scipy/scipy/labels/Documentation","name":"Documentation","color":"207de5","default":false},{"id":37341004,"url":"https://api.github.com/repos/scipy/scipy/labels/scipy.sparse","name":"scipy.sparse","color":"207de5","default":false}],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":3,"created_at":"2016-11-05T17:51:01Z","updated_at":"2016-12-06T21:49:04Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/scipy/scipy/pulls/6762","html_url":"https://github.com/scipy/scipy/pull/6762","diff_url":"https://github.com/scipy/scipy/pull/6762.diff","patch_url":"https://github.com/scipy/scipy/pull/6762.patch"},"body":"I always was bothered that some methods in sparse matrices had just empty docstrings. So initially I tried to provide a docstring for each method.\r\n\r\nI also changed method docstring in `dok_matrix` which weren't rendered reasonably by Sphinx (these are methods inherited from dict). I think farther improvements can be made in this direction, i.e. write docstrings more to the point for each method inherited from dict.\r\n\r\nBesides adding missing docstrings, I think we can also make them generally better and more consistent. I suggest to work on all that in this PR. "},"comment":{"url":"https://api.github.com/repos/scipy/scipy/issues/comments/265283406","html_url":"https://github.com/scipy/scipy/pull/6762#issuecomment-265283406","issue_url":"https://api.github.com/repos/scipy/scipy/issues/6762","id":265283406,"user":{"login":"nmayorov","id":7074023,"avatar_url":"https://avatars.githubusercontent.com/u/7074023?v=3","gravatar_id":"","url":"https://api.github.com/users/nmayorov","html_url":"https://github.com/nmayorov","followers_url":"https://api.github.com/users/nmayorov/followers","following_url":"https://api.github.com/users/nmayorov/following{/other_user}","gists_url":"https://api.github.com/users/nmayorov/gists{/gist_id}","starred_url":"https://api.github.com/users/nmayorov/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nmayorov/subscriptions","organizations_url":"https://api.github.com/users/nmayorov/orgs","repos_url":"https://api.github.com/users/nmayorov/repos","events_url":"https://api.github.com/users/nmayorov/events{/privacy}","received_events_url":"https://api.github.com/users/nmayorov/received_events","type":"User","site_admin":false},"created_at":"2016-12-06T21:49:04Z","updated_at":"2016-12-06T21:49:04Z","body":"I addressed what you mentioned.\r\n\r\nThe docstrings in sparse generally don't follow the proper convention, but usually they are enough to understand how to use methods. I can either continue expanding them or we can leave this PR as a minimum improvement and someone can continue later."}}
{"actor":{"display_login":"nmayorov"}}