scienxlab
Pull 'how it works' out of 'what to do' in sklearn docs
The 'what to do' section in https://code.agilescientific.com/redflag/_notebooks/Using_redflag_with_sklearn.html contains some stuff about how the detectors work. These should be separated.
Sure, thanks for asking.
Take this section of "What to do about the warnings" for example:
Really, the "Here's what this thing does" piece (the bullet points, basically) is about how the detector works. So it should probably be removed and put in the docstring for the class.
The rest of it, after the bullets, should remain in this section of the docs.
If I am right the four bulleted paras need to be removed and put in the docstring for class?? Since I am no expert in python ,I need more info on how I could go about at this particular point…” put in the docstring for class”?
In addition I found a typo error in the third para,second line where I am sure it must be “such“ instead of “wuch”.
Sent from my iPad
On 27-Aug-2022, at 12:40 AM, Matt Hall @.***> wrote:
Sure, thanks for asking.
Take this section of "What to do about the warnings" for example:
Really, the "Here's what this thing does" piece (the bullet points, basically) is about how the detector works. So it should probably be removed and put in the docstring for the class.
The rest of it, after the bullets, should remain in this section of the docs.
— Reply to this email directly, view it on GitHub, or unsubscribe. You are receiving this because you commented.
That's what I was thinking -- at least until someone wants to write more documentation, the docstring is probably the place for it. Probably a job for a Python programmer.
Thank you for the typo! Fixed in dev.
👍
On 28-Aug-2022, at 7:02 PM, Matt Hall @.***> wrote:
That's what I was thinking -- at least until someone wants to write more documentation, the docstring is probably the place for it. Probably a job for a Python programmer.
Thank you for the typo! Fixed in dev.
— Reply to this email directly, view it on GitHub https://github.com/agilescientific/redflag/issues/5#issuecomment-1229457843, or unsubscribe https://github.com/notifications/unsubscribe-auth/AROMJUNVCYLQNNG35PZ5JSLV3NS5FANCNFSM57ULF2KA. You are receiving this because you commented.