Mailman 3 July 2014 - docs

[issue21902] Docstring of math.acosh, asinh, and atanh
by Tim Peters July 5, 2014

July 5, 2014

Tim Peters added the comment: One more useless ;-) data point, from Macsyma: ? acosh; -- Function: acosh (<x>) - Hyperbolic Arc Cosine. I don't like "area" - while accurate, nobody else uses it. Gratuitous novelty is no virtue ;-) I like "inverse" better than "arc", because it's all of accurate, common, and nearly self-evident. ---------- nosy: +tim.peters _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21902> _______________________________________

1 0

[issue21902] Docstring of math.acosh, asinh, and atanh
by Kevin Davies July 5, 2014

July 5, 2014

Kevin Davies added the comment: I'm not sure what the resolution is (the patch was 'inverse', Mark said he'd be happy to use 'area', and Raymond quoted 'arc'). I didn't know this would be a big deal, and I'm sorry that I caused trouble. But since one of the concerns was divergence, I thought I'd send some info on how the tools I've used describe it -- universally as 'inverse' in those that I found: - Mathematica: ArcCosh[z] "gives the inverse hyperbolic cosine [...]" (http://reference.wolfram.com/mathematica/ref/ArcCosh.html) - Modelica Standard Library: acosh "Inverse of cosh (area hyperbolic cosine)" (http://reference.wolfram.com/system-modeler/libraries/Modelica/Modelica_Mat…) - Maple: arccosh, but unknown description (http://www.maplesoft.com/support/help/Maple/view.aspx?path=invtrig) - MATLAB: acosh " Inverse hyperbolic cosine" (http://www.mathworks.com/help/matlab/ref/acosh.html) - TI-89 calculator: cosh-1 "returns the inverse hyperbolic cosine [...]" (from manual) Respectfully, Kevin ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21902> _______________________________________

1 0

[issue21902] Docstring of math.acosh, asinh, and atanh
by Kevin Davies July 5, 2014

July 5, 2014

Changes by Kevin Davies <daviesk24(a)yahoo.com>: Added file: http://bugs.python.org/file35863/TI-89.png _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21902> _______________________________________

1 0

[issue21902] Docstring of math.acosh, asinh, and atanh
by Raymond Hettinger July 5, 2014

July 5, 2014

Raymond Hettinger added the comment: > I'd be happy to replace the 'inverse' by 'arc' > if that's what people prefer. Yes, please. > And the "in radians" bit is utterly nonsensical Yes, again. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21902> _______________________________________

1 0

[issue21902] Docstring of math.acosh, asinh, and atanh
by Mark Dickinson July 4, 2014

July 4, 2014

Mark Dickinson added the comment: Raymond: I don't think it's gratuitous. I'd be happy to replace the 'inverse' by 'area' if that's what people prefer. But "hyperbolic arc cosine" is just plain incorrect. (And the "in radians" bit is utterly nonsensical.) ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21902> _______________________________________

1 0

[issue21915] telnetlib.Telnet constructor does not match telnetlib.Telnet.__init__ docstring
by Garrett Cooper July 4, 2014

July 4, 2014

New submission from Garrett Cooper: telnetlib.Telnet.__init__ supports keyword arguments, but the documentation for 2.7.8 ( https://docs.python.org/2/library/telnetlib.html ) claims they're non-keyword arguments. The py3k docs are much better ( https://docs.python.org/3/library/telnetlib.html ), but unfortunately they still claim that timeout is a non-keyword argument. ---------- assignee: docs@python components: Documentation messages: 222263 nosy: docs@python, yaneurabeya priority: normal severity: normal status: open title: telnetlib.Telnet constructor does not match telnetlib.Telnet.__init__ docstring _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21915> _______________________________________

2 2

Wrong link in Python 3.3 documentation index – exec
by Draic Kin July 4, 2014

July 4, 2014

In Python 3.3 documentation index, the link on exec leads to http://docs.python.org/3/reference/simple_stmts.html#index-42 which is incorrect.

2 1

[issue21902] Docstring of math.acosh, asinh, and atanh
by Raymond Hettinger July 4, 2014

July 4, 2014

Raymond Hettinger added the comment: > inverse' is probably more obvious to understand than 'area', > although it doesn't tie into the 'a' of 'acosh', etc. Please don't make this gratuitous change. The decision about whether to use "inverse" or "arc" was cast in stone when the functions were named "acosh" etc. The documentation for C's math.h uses "arc". The docs for my hand calculators all use the term "arc" in the description of what the keys do. Why create unnecessary divergence? If you truly think users of acosh can't cope with "arc", then add a clarifying parenthetical for "inverse". But don't make the function name "acosh" more opaque by not showing what it actually stands for. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21902> _______________________________________

1 0

[issue12842] Docs: first parameter of tp_richcompare() always has the correct type
by Stefan Krah July 3, 2014

July 3, 2014

New submission from Stefan Krah <stefan-usenet(a)bytereef.org>: I've noticed that assumptions about the operand types in tp_richcompare() are not always consistent. As far as I can see, the first parameter in tp_richcompare() is guaranteed to be of the correct type. But in some places the first parameter's type is still checked: Objects/cellobject.c: if (!PyCell_Check(a) || !PyCell_Check(b)) { The attached patch makes it clear that the first parameter has the correct type. ---------- assignee: docs@python components: Documentation files: tp_richcompare.diff keywords: patch messages: 142991 nosy: docs@python, skrah priority: normal severity: normal status: open title: Docs: first parameter of tp_richcompare() always has the correct type type: feature request versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3 Added file: http://bugs.python.org/file23047/tp_richcompare.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12842> _______________________________________

4 3

Enhancements to gettext docs (issue 10536)
by andreas.r.maier＠gmx.de July 3, 2014

July 3, 2014

Added a minor comment on using the context handler approach for opening a file in example code. http://bugs.python.org/review/10536/diff/1792/Doc/library/gettext.rst File Doc/library/gettext.rst (right): http://bugs.python.org/review/10536/diff/1792/Doc/library/gettext.rst#newco… Doc/library/gettext.rst:446: fp.close() The fp.close() is not needed, because the context handler exit closes the file (see https://docs.python.org/2.7/library/stdtypes.html#file.close). I fully agree with the change to use the context handler approach for opening the file, and if we use it we should be consequent and rely on it fully. http://bugs.python.org/review/10536/

1 0