[issue12185] Decimal documentation lists first and second arguments, should be self and other

Raymond Hettinger raymond.hettin...@gmail.com added the comment: Sorry, I'm going to reject this one. I applied the patch and looked at the generated docs, finding them to be less readable than before. AFAICT, we've had no issues with people mis-reading the text as currently presented.

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Francisco Martín Brugué franci...@email.de added the comment: Hi Adam, I couldn’t see that from the threat context, I'm new to this and just wanted to learn the work flow and tools so I've just picked up an easy issue to start with. Anyway your patch seems more complete. --

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Changes by Mark Dickinson dicki...@gmail.com: -- nosy: +mark.dickinson ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12185 ___ ___

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Francisco Martín Brugué franci...@email.de added the comment: Hi all, that is my first contribution. Please let me know if all it's OK. Thanks in advance ! -- keywords: +patch nosy: +francismb Added file: http://bugs.python.org/file8/issue_12185.patch

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Adam Woodbeck adam.woodb...@gmail.com added the comment: Hi Francisco, I finally found time to create a patch for this issue. I was just saving the patch I wrote as your update arrived in my inbox. I've included my patch for good measure. It's better to have two proposed patches than none

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Raymond Hettinger raymond.hettin...@gmail.com added the comment: I'm not sure this improves the docs. Will give it more thought and thorough review at a later date. Also, I will compare it to the docstrings in the spec itself. -- priority: normal - low

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Adam Woodbeck adam.woodb...@gmail.com added the comment: I propose: object.copy_sign(other) Return a copy of *object* with the sign set to be the same as the sign of *other*. This format is most familiar to me. But like Ezio wrote, all other methods referring to first and second

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Adam Woodbeck adam.woodb...@gmail.com added the comment: Or rather: object.copy_sign(other) Return a copy of *object* with the sign set to be that of *other*. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12185

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Adam Woodbeck adam.woodb...@gmail.com added the comment: Sorry guys. I'm new at this. After reviewing this thread, Terry's suggestion makes the most sense to me. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12185

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Ezio Melotti ezio.melo...@gmail.com added the comment: Note that usually 'self' is not included in the arguments of methods. The 3.3 doc correctly uses e.g. copy_sign(other). A 'd.' could also be added so that the end result looks like: d.copy_sign(other) but it's not mandatory (if done,

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Changes by Adam Woodbeck adam.woodb...@gmail.com: -- nosy: +adam.woodbeck ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12185 ___ ___

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Eric V. Smith e...@trueblade.com added the comment: I'm not talking about the method itself but rather the descriptive text. For example: copy_sign(other) Return a copy of the first operand with the sign set to be the same as the sign of the second operand. There is no second operand,

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Changes by Raymond Hettinger raymond.hettin...@gmail.com: -- assignee: docs@python - rhettinger nosy: +rhettinger ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12185 ___

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Terry J. Reedy tjre...@udel.edu added the comment: Return a copy of *self* with the sign set to be the same as the sign of *other*. seems clearer to me. -- nosy: +terry.reedy ___ Python tracker rep...@bugs.python.org

[issue12185] Decimal documentation lists first and second arguments, should be self and other

Ezio Melotti ezio.melo...@gmail.com added the comment: In this case using: d.copy_sign(other) and then refer to 'd' and 'other' might be clearer. -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue12185

[issue12185] Decimal documentation lists first and second arguments, should be self and other

New submission from Eric V. Smith e...@trueblade.com: http://docs.python.org/library/decimal.html In 9.4.2, Decimal objects, some of the methods mention the first and second parameters, when really it should be self and the argument, usually named other and sometimes something more specific.