[issue38040] Typo: "Writeable" Should be "Writable" in IO Library Documentation
New submission from Sean Happenny : Problem: There are 4 instances of the typo "writeable" in the documentation for the IO library affecting, at least, versions 3.7, 3.8, 3.9, and the latest master of the documentation (https://docs.python.org/[3.7,3.8,3.9]/library/io.html and https://github.com/python/cpython/blob/master/Doc/library/io.rst). This can cause confusion to the reader. The instances are under the "BufferedWriter" section (https://docs.python.org/3/library/io.html#io.BufferedWriter) and "BufferedRWPair" section (https://docs.python.org/3.7/library/io.html#io.BufferedRWPair). Fix: Change all instances of "writeable" to "writable" in the IO library documentation. -- assignee: docs@python components: Documentation, IO messages: 351216 nosy: Sean Happenny, docs@python priority: normal severity: normal status: open title: Typo: "Writeable" Should be "Writable" in IO Library Documentation type: enhancement versions: Python 3.7, Python 3.8, Python 3.9 ___ Python tracker <https://bugs.python.org/issue38040> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue38040] Typo: "Writeable" Should be "Writable" in IO Library Documentation
Sean Happenny added the comment: It is a minor issue and I understand that there are many, much more important fixes and features the whole Python dev team is working on. But reading the documentation for these classes indicates that these classes may have a "writeable" member. If, as an example, the user then needs to examine the implementation of these classes and searches for "writeable" in the CPython, they'll find instances in comments, but not in the code. This may cause them to miss the real spelling of the method "writable()". Also, another justification is that the documentation should be correct and currently it is not. This fix should be a very simple find-and-replace, but does touch multiple files (probably more than those I referenced) and I understand how that is. On Thu, Sep 5, 2019, 11:44 SilentGhost wrote: > > SilentGhost added the comment: > > There are more cases of using this spelling in the code base, but I > personally don't see how any confusion can arise and why this "fix" is > needed. > > -- > nosy: +SilentGhost > > ___ > Python tracker > <https://bugs.python.org/issue38040> > ___ > -- ___ Python tracker <https://bugs.python.org/issue38040> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
