  please learn a little of english language before using  on top of that  please learn a little of python before commiting the patches  overall  this docstring is bad and you should feel bad  learning why this is a bad docstring is left for you as an exercise 