Mailman 3 June 2018 - docs

[issue33892] doc Add a couple of "or she/her"
by Andrés Delfino June 18, 2018

June 18, 2018

New submission from Andrés Delfino <adelfino(a)gmail.com>: PR adds some "or she/her". ---------- assignee: docs@python components: Documentation messages: 319840 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Add a couple of "or she/her" type: enhancement versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33892> _______________________________________

4 13

[issue33894] tempfile.tempdir cannot be unset
by Eric V. Smith June 18, 2018

June 18, 2018

Eric V. Smith <eric(a)trueblade.com> added the comment: "If tempdir is unset or None" means "If tempdir has not been assigned to, or if it has been assigned the value None". "Unset" doesn't mean "delete from the module". I agree the documentation wording could be improved. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, eric.smith type: crash -> behavior _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33894> _______________________________________

1 0

[issue33889] doc Mention Python on-line shell in Tutorial
by Andrés Delfino June 17, 2018

June 17, 2018

New submission from Andrés Delfino <adelfino(a)gmail.com>: If having a link to that specific console is not deemed appropriate, perhaps we can point to PythonAnywhere. IMHO, it's good to let users know that they can try Python right away without needing to install. ---------- assignee: docs@python components: Documentation messages: 319829 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Mention Python on-line shell in Tutorial type: enhancement versions: Python 2.7, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33889> _______________________________________

2 3

[issue29560] Tkinter and turtle graphics fill differs between Windows and *nix
by Terry J. Reedy June 16, 2018

June 16, 2018

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: Behavior has not changed. It is a legitimate doc issue for both tkinter and turtle. The turtle intro, https://docs.python.org/3/library/turtle.html#introduction, currently 24.1.1. says nothing about the sidebar and image. I think there should be a short paragraph added, which includes "The image was drawn on Linux. On Windows, the star will be filled in solid." The filling doc, https://docs.python.org/3/library/turtle.html#filling, should also have a note. If you do a PR, I will review. The tkinter docs should be handled separately. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python stage: -> needs patch title: Turtle graphics fill behavior differs between versions -> Tkinter and turtle graphics fill differs between Windows and *nix versions: +Python 3.7, Python 3.8 -Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue29560> _______________________________________

1 0

[issue24978] Contributing to Python 2x and 3x Documentation. Translation to Russian.
by Eugene June 16, 2018

June 16, 2018

New submission from Eugene: I am very much begging pardon if this is not the place to ask for, but.. I would like to make a thorough translation of the official Library Reference and the beginners guide to Python 2.x 3.x in Russian language. I am aware this type of translation will be placed at https://wiki.python.org/moin/RussianLanguage as current https://docs.python.org/2/ does not allow changing language. I am pretty much aware the translation should not sound any differently from the original in terms of its style, form and overall attitude. And I would also like to know, if possible, can this link be promoted somewhere at python.org. I am not in the slightest have the intentions of promoting in anywhere but in the place where most russian programmers could most definitely find it - at the oficial Python website. Kind regards, Evgeniy. ---------- assignee: docs@python components: Documentation messages: 249478 nosy: docs@python, overr1de priority: normal severity: normal status: open title: Contributing to Python 2x and 3x Documentation. Translation to Russian. type: enhancement versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24978> _______________________________________

6 5

[issue22571] Remove import * recommendations and examples in doc?
by Terry J. Reedy June 16, 2018

June 16, 2018

New submission from Terry J. Reedy: PEP 8 recommends against 'from mod import *' because it makes reading harder and is bad for code analysis. My experience with retrofitting tests to idlelib modules with tkinter * imports is that it also makes testing harder since the testing strategy depends on the specific tkinter objects actually used. So either an explicit list ('from tkinter import x, y, z') or a searchable prefix ('tk.') makes testing easier. Some time ago, 'from tkinter import *' was changed to 'import tkinter as tk' in the tkinter doc examples, though *not* the text. ##10031 changed the import section of the FAQ to "remove the advice to use "from ... import *" with some modules" (from the commit message). Should we finish the job? Or leave the issue to individual chapter authors? Here is the edited result of grepping 'import *' in ...\py34\Doc\*.rst with Idle. F:\Python\dev\4\py34\Doc\distutils\apiref.rst: 1289: This module is safe to use in ``from ... import *`` mode; it only exports F:\Python\dev\4\py34\Doc\library\cmd.rst: 234: from turtle import * F:\Python\dev\4\py34\Doc\library\collections.abc.rst: 14: from collections import * F:\Python\dev\4\py34\Doc\library\collections.rst: 11: from collections import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 54: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 86: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 320: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 562: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 671: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 695: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 714: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 914: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 1074: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\ctypes.rst: 1122: >>> from ctypes import * F:\Python\dev\4\py34\Doc\library\decimal.rst: 20: from decimal import * F:\Python\dev\4\py34\Doc\library\decimal.rst: 56: >>> from decimal import * F:\Python\dev\4\py34\Doc\library\decimal.rst: 125: >>> from decimal import * F:\Python\dev\4\py34\Doc\library\difflib.rst: 13: from difflib import * F:\Python\dev\4\py34\Doc\library\itertools.rst: 12: from itertools import * F:\Python\dev\4\py34\Doc\library\stat.rst: 104: from stat import * F:\Python\dev\4\py34\Doc\library\statistics.rst: 13: from statistics import * F:\Python\dev\4\py34\Doc\library\struct.rst: 313: >>> from struct import * F:\Python\dev\4\py34\Doc\library\tkinter.rst: 63: from tkinter import * F:\Python\dev\4\py34\Doc\library\tkinter.rst: 580: from tkinter import * F:\Python\dev\4\py34\Doc\library\tkinter.tix.rst: 60: from tkinter.constants import * F:\Python\dev\4\py34\Doc\library\tkinter.ttk.rst: 38: from tkinter import * F:\Python\dev\4\py34\Doc\library\tkinter.ttk.rst: 39: from tkinter.ttk import * F:\Python\dev\4\py34\Doc\library\turtle.rst: 11: from turtle import * F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 102: >>> from fibo import * F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 461: Now what happens when the user writes ``from sound.effects import *``? Ideally, F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 470: list of module names that should be imported when ``from package import *`` is F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 479: This would mean that ``from sound.effects import *`` would import the three F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 482: If ``__all__`` is not defined, the statement ``from sound.effects import *`` F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 493: from sound.effects import * F:\Python\dev\4\py34\Doc\tutorial\modules.rst: 501: patterns when you use ``import *``, it is still considered bad practise in F:\Python\dev\4\py34\Doc\tutorial\stdlib2.rst: 372: >>> from decimal import * I removed the reference hits that simply explain. I have not looked at whether the tutorial goes beyond explanation, but should this even be mentioned in so many places? ---------- assignee: docs@python components: Documentation messages: 228734 nosy: docs@python, georg.brandl, terry.reedy priority: normal severity: normal stage: needs patch status: open title: Remove import * recommendations and examples in doc? versions: Python 2.7, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22571> _______________________________________

5 5

[issue27461] Optimize PNGs
by Ville Skyttä June 16, 2018

June 16, 2018

New submission from Ville Skyttä: Running PNGs through zopflipng makes them smaller, with no drawbacks. This patch was done with zopflipng version 1.0.1 with the -m option, and decreases the in-tree total size size of all *.png by almost 100KiB. $ find -name "*.png" | xargs du -bc | tail -n 1 # before 291101 total $ find -name "*.png" | xargs du -bc | tail -n 1 # after 194639 total ---------- assignee: docs@python components: Documentation files: pngs.patch keywords: patch messages: 269929 nosy: docs@python, scop priority: normal severity: normal status: open title: Optimize PNGs type: enhancement Added file: http://bugs.python.org/file43653/pngs.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27461> _______________________________________

3 6

[issue33571] Add triple quotes to list of delimiters that trigger '...' prompt
by Mariatta Wijaya June 16, 2018

June 16, 2018

New submission from Mariatta Wijaya <mariatta.wijaya(a)gmail.com>: New changeset 68680035143a3a6398faa88f067f244c74691d19 by Mariatta (Andrés Delfino) in branch 'master': bpo-33571: Improve the glossary description for '...' prompt (GH-6971) https://github.com/python/cpython/commit/68680035143a3a6398faa88f067f244c74… ---------- nosy: +Mariatta _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33571> _______________________________________

2 7

[issue33836] [Good first-time issue] Recommend keyword-only param for memoization in FAQ
by Zachary Ware June 15, 2018

June 15, 2018

New submission from Zachary Ware <zachary.ware(a)gmail.com>: In https://docs.python.org/3/faq/programming.html#why-are-default-values-share… there is an example showing memoization using `def expensive(arg1, arg2, _cache={}):`. We should change the signature in that example to make `_cache` a keyword-only parameter and possibly adjust the comment to note that that's been done to prevent accidental calls with three positional arguments. Note to existing contributors: if this wouldn't be within your first couple of patches, please leave this for a new contributor to find. Thanks! ---------- assignee: docs@python components: Documentation keywords: easy messages: 319310 nosy: docs@python, zach.ware priority: normal severity: normal stage: needs patch status: open title: [Good first-time issue] Recommend keyword-only param for memoization in FAQ versions: Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33836> _______________________________________

5 9

[issue33854] doc Add PEP title in seealso of Built-in Types
by Andrés Delfino June 15, 2018

June 15, 2018

New submission from Andrés Delfino <adelfino(a)gmail.com>: Add PEP 461 title to Built-in Types seealso. ---------- assignee: docs@python components: Documentation messages: 319493 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Add PEP title in seealso of Built-in Types type: enhancement versions: Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33854> _______________________________________

3 7