{"action":"created","issue":{"url":"https://api.github.com/repos/astropy/astropy/issues/3858","repository_url":"https://api.github.com/repos/astropy/astropy","labels_url":"https://api.github.com/repos/astropy/astropy/issues/3858/labels{/name}","comments_url":"https://api.github.com/repos/astropy/astropy/issues/3858/comments","events_url":"https://api.github.com/repos/astropy/astropy/issues/3858/events","html_url":"https://github.com/astropy/astropy/issues/3858","id":88669771,"number":3858,"title":"Better explain masked arrays in sigma_clip","user":{"login":"astrofrog","id":314716,"avatar_url":"https://avatars.githubusercontent.com/u/314716?v=3","gravatar_id":"","url":"https://api.github.com/users/astrofrog","html_url":"https://github.com/astrofrog","followers_url":"https://api.github.com/users/astrofrog/followers","following_url":"https://api.github.com/users/astrofrog/following{/other_user}","gists_url":"https://api.github.com/users/astrofrog/gists{/gist_id}","starred_url":"https://api.github.com/users/astrofrog/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/astrofrog/subscriptions","organizations_url":"https://api.github.com/users/astrofrog/orgs","repos_url":"https://api.github.com/users/astrofrog/repos","events_url":"https://api.github.com/users/astrofrog/events{/privacy}","received_events_url":"https://api.github.com/users/astrofrog/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/astropy/astropy/labels/Docs","name":"Docs","color":"02d7e1"},{"url":"https://api.github.com/repos/astropy/astropy/labels/Effort-low","name":"Effort-low","color":"fef2c0"},{"url":"https://api.github.com/repos/astropy/astropy/labels/Package-novice","name":"Package-novice","color":"bfe5bf"},{"url":"https://api.github.com/repos/astropy/astropy/labels/stats","name":"stats","color":"c7def8"}],"state":"open","locked":false,"assignee":null,"milestone":null,"comments":8,"created_at":"2015-06-16T09:15:19Z","updated_at":"2016-03-12T14:35:05Z","closed_at":null,"body":"For many users, sigma_clip may be where they encounter masked arrays for the first time. It would be nice to improve the docstring for sigma_clip:\r\n\r\nhttp://docs.astropy.org/en/stable/api/astropy.stats.sigma_clip.html#astropy.stats.sigma_clip\r\n\r\nto include a few lines on what a masked array is (including a printed view), just before we mention that Numpy ufuncs often understand them. Alternatively, we could link to http://docs.scipy.org/doc/numpy/reference/maskedarray.html but that is a bit extensive."},"comment":{"url":"https://api.github.com/repos/astropy/astropy/issues/comments/195750677","html_url":"https://github.com/astropy/astropy/issues/3858#issuecomment-195750677","issue_url":"https://api.github.com/repos/astropy/astropy/issues/3858","id":195750677,"user":{"login":"crawfordsm","id":1107188,"avatar_url":"https://avatars.githubusercontent.com/u/1107188?v=3","gravatar_id":"","url":"https://api.github.com/users/crawfordsm","html_url":"https://github.com/crawfordsm","followers_url":"https://api.github.com/users/crawfordsm/followers","following_url":"https://api.github.com/users/crawfordsm/following{/other_user}","gists_url":"https://api.github.com/users/crawfordsm/gists{/gist_id}","starred_url":"https://api.github.com/users/crawfordsm/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/crawfordsm/subscriptions","organizations_url":"https://api.github.com/users/crawfordsm/orgs","repos_url":"https://api.github.com/users/crawfordsm/repos","events_url":"https://api.github.com/users/crawfordsm/events{/privacy}","received_events_url":"https://api.github.com/users/crawfordsm/received_events","type":"User","site_admin":false},"created_at":"2016-03-12T14:35:04Z","updated_at":"2016-03-12T14:35:04Z","body":"@AMAN3003 Can you do a pull request for your commit and then we should be able to comment on it.  However, as @embray says, it might be better to add it into the generally documentation or a separate page within the documentation dealing with how masked arrays are used. "}}