{"action":"created","issue":{"url":"https://api.github.com/repos/scipy/scipy/issues/5083","labels_url":"https://api.github.com/repos/scipy/scipy/issues/5083/labels{/name}","comments_url":"https://api.github.com/repos/scipy/scipy/issues/5083/comments","events_url":"https://api.github.com/repos/scipy/scipy/issues/5083/events","html_url":"https://github.com/scipy/scipy/pull/5083","id":97145083,"number":5083,"title":"Fix integrate.fixed_quad docstring to indicate None return value","user":{"login":"synapticarbors","id":589279,"avatar_url":"https://avatars.githubusercontent.com/u/589279?v=3","gravatar_id":"","url":"https://api.github.com/users/synapticarbors","html_url":"https://github.com/synapticarbors","followers_url":"https://api.github.com/users/synapticarbors/followers","following_url":"https://api.github.com/users/synapticarbors/following{/other_user}","gists_url":"https://api.github.com/users/synapticarbors/gists{/gist_id}","starred_url":"https://api.github.com/users/synapticarbors/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/synapticarbors/subscriptions","organizations_url":"https://api.github.com/users/synapticarbors/orgs","repos_url":"https://api.github.com/users/synapticarbors/repos","events_url":"https://api.github.com/users/synapticarbors/events{/privacy}","received_events_url":"https://api.github.com/users/synapticarbors/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":1,"created_at":"2015-07-24T20:54:24Z","updated_at":"2015-07-26T13:12:28Z","closed_at":null,"pull_request":{"url":"https://api.github.com/repos/scipy/scipy/pulls/5083","html_url":"https://github.com/scipy/scipy/pull/5083","diff_url":"https://github.com/scipy/scipy/pull/5083.diff","patch_url":"https://github.com/scipy/scipy/pull/5083.patch"},"body":"I noticed that `scipy.integrate.fixed_quad` return a tuple with the second element always equal to `None`, that is not documented (I had to look at the source code to realize why I was getting a tuple back instead of just a float). This has been in the code for a long time and it looks like previous versions of the docstring properly accounted for this, but the current version does not. \r\n\r\nI assume there is some legacy reason for always returning a None, and a quick search of Github shows that most people use it as something like:\r\n\r\n```python\r\nval = scipy.integrate.fixed_quad(...)[0]\r\n```\r\n\r\nI'm not sure my proposed docstring is optimally worded, but I'm happy to adjust it if others have suggestions."},"comment":{"url":"https://api.github.com/repos/scipy/scipy/issues/comments/124983843","html_url":"https://github.com/scipy/scipy/pull/5083#issuecomment-124983843","issue_url":"https://api.github.com/repos/scipy/scipy/issues/5083","id":124983843,"user":{"login":"ev-br","id":2133832,"avatar_url":"https://avatars.githubusercontent.com/u/2133832?v=3","gravatar_id":"","url":"https://api.github.com/users/ev-br","html_url":"https://github.com/ev-br","followers_url":"https://api.github.com/users/ev-br/followers","following_url":"https://api.github.com/users/ev-br/following{/other_user}","gists_url":"https://api.github.com/users/ev-br/gists{/gist_id}","starred_url":"https://api.github.com/users/ev-br/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ev-br/subscriptions","organizations_url":"https://api.github.com/users/ev-br/orgs","repos_url":"https://api.github.com/users/ev-br/repos","events_url":"https://api.github.com/users/ev-br/events{/privacy}","received_events_url":"https://api.github.com/users/ev-br/received_events","type":"User","site_admin":false},"created_at":"2015-07-26T13:12:28Z","updated_at":"2015-07-26T13:12:28Z","body":"Not sure what the best wording is, but yeah, \"a bit strange\" is better than plain misleading. And this stray None is a bit strange. Merged, thank you @synapticarbors."}}