[issue18768] Wrong documentation of RAND_egd function in ssl module
New submission from Vajrasky Kok: import ssl ssl.RAND_egd.__doc__ RAND_egd(path) - bytes\n\nQueries the entropy gather daemon (EGD) on the socket named by 'path'.\nReturns number of bytes read. Raises SSLError if connection to EGD\nfails or if it does provide enough data to seed PRNG. Compare it to documentation about RAND_egd() function from openssl website (https://www.openssl.org/docs/crypto/RAND_egd.html): RAND_egd() and RAND_egd_bytes() return the number of bytes read from the daemon on success, and -1 if the connection failed or the daemon did not return enough data to fully seed the PRNG. Attached the patch to fix the documentation. I am not sure whether we should put the word fully or not. On the side note: In line 813 in Modules/_ssl.c (the same file where my patch fixed the documentation about RAND_egd function): gntype = name- type; The space between - and type irritates my eyes. Maybe we can fix this while we fix the documentation? Anyway, this is not really important. I just want to expose it to public and think this does not deserve a dedicated ticket. -- assignee: docs@python components: Documentation files: fix_documentation_on_rand_egd_function.patch keywords: patch messages: 195482 nosy: christian.heimes, docs@python, vajrasky priority: normal severity: normal status: open title: Wrong documentation of RAND_egd function in ssl module versions: Python 3.3, Python 3.4 Added file: http://bugs.python.org/file31338/fix_documentation_on_rand_egd_function.patch ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue18768 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue18768] Wrong documentation of RAND_egd function in ssl module
Roundup Robot added the comment: New changeset b352a5cb60b6 by Christian Heimes in branch '3.3': Issue #18768: coding style nitpick. Thanks to Vajrasky Kok http://hg.python.org/cpython/rev/b352a5cb60b6 New changeset fe444f324756 by Christian Heimes in branch 'default': Issue #18768: coding style nitpick. Thanks to Vajrasky Kok http://hg.python.org/cpython/rev/fe444f324756 New changeset a8787a6fa107 by Christian Heimes in branch '2.7': Issue #18768: coding style nitpick. Thanks to Vajrasky Kok http://hg.python.org/cpython/rev/a8787a6fa107 -- nosy: +python-dev ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue18768 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue18768] Wrong documentation of RAND_egd function in ssl module
Christian Heimes added the comment: Thanks, I have removed the extra space in gntype = name- type; -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue18768 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue18768] Wrong documentation of RAND_egd function in ssl module
Roundup Robot added the comment: New changeset ae91252943bf by Christian Heimes in branch '3.3': Issue 18768: Correct doc string of RAND_edg(). Patch by Vajrasky Kok. http://hg.python.org/cpython/rev/ae91252943bf New changeset 5c091acc799f by Christian Heimes in branch 'default': Issue 18768: Correct doc string of RAND_edg(). Patch by Vajrasky Kok. http://hg.python.org/cpython/rev/5c091acc799f New changeset 31389495cdbf by Christian Heimes in branch '2.7': Issue 18768: Correct doc string of RAND_edg(). Patch by Vajrasky Kok. http://hg.python.org/cpython/rev/31389495cdbf -- ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue18768 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue18768] Wrong documentation of RAND_egd function in ssl module
Christian Heimes added the comment: Thanks :) -- resolution: - fixed stage: - committed/rejected status: open - closed ___ Python tracker rep...@bugs.python.org http://bugs.python.org/issue18768 ___ ___ Python-bugs-list mailing list Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
