Mailman 3 November 2010 - docs

[issue7061] Improve turtle module documentation
by Alexander Belopolsky Nov. 9, 2010

Nov. 9, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: As a follow-up to Raymond's suggestion, I am attaching a patch that will add a sidebar to the introduction section of the turtle documentation section. While it is not common to include screenshots in python documentation, I think it is very appropriate for a visual module such as turtle. I considered a "Basic example" subsection similar to that in unittest module documentation, but turtle introduction already has a basic example (forward(15); left(25) embedded in the prose, so I think a sidebar like this is more appropriate. Since svn does not include binary files in the patch, I will have to attach the embedded image separately. I will also post a screenshot of the rendered HTML page. ---------- Added file: http://bugs.python.org/file19557/turtle-star-sidebar.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

Typo in ConfigParser documentation
by Eriel Thomas Nov. 9, 2010

Nov. 9, 2010

In the third paragraph of the ConfigParser documentation ( http://docs.python.org/library/configparser.html), there is a typo where the word "spection" should instead read "section". Thanks, Eriel Thomas

2 1

[issue10351] Add autocompletion for keys in dictionaries
by Valery Khamenya Nov. 9, 2010

Nov. 9, 2010

Valery Khamenya <khamenya(a)gmail.com> added the comment: Hi Éric, thanks for guiding. So, attached is the concatenation of two forward unified diffs for rlcompleter.py and test_rlcompleter.py -- both as of py3k trunk. Tested against Python 3.1.2 though. P.S. hm, py3k code appeared to be surprisingly nicer -- no unicode troubles and work-arounds at all... regards Valery ---------- assignee: -> docs@python components: +Documentation keywords: +patch nosy: +docs@python Added file: http://bugs.python.org/file19555/patch.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10351> _______________________________________

1 0

[issue10318] "make altinstall" installs many files with incorrect shebangs
by Senthil Kumaran Nov. 9, 2010

Nov. 9, 2010

Changes by Senthil Kumaran <orsenthil(a)gmail.com>: ---------- nosy: +orsenthil _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10318> _______________________________________

1 0

[issue7061] Improve turtle module documentation
by Alexander Belopolsky Nov. 9, 2010

Nov. 9, 2010

Changes by Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: ---------- title: Improve 24.5. turtle doc -> Improve turtle module documentation _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

[issue7061] Improve 24.5. turtle doc
by Alexander Belopolsky Nov. 9, 2010

Nov. 9, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: >From IRC (raymondh): in the turtle docs, can you add a quick start guide (like we have in the unittest docs) the turtle docs have grown into a small book and is intimidating to get started with. ---------- nosy: +rhettinger _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7061> _______________________________________

1 0

http://docs.python.org/library/datetime.html has a sample which contradicts advice on the page
by Justin Grant Nov. 8, 2010

Nov. 8, 2010

The datetime docs (http://docs.python.org/library/datetime.html) have a code sample which doesn't follow advice from another part of the same page. First, here's the advice: Special requirement for pickling: A tzinfo<http://docs.python.org/library/datetime.html#datetime.tzinfo> subclass must have an __init__()<http://docs.python.org/reference/datamodel.html#object.__init__> method that can be called with no arguments, else it can be pickled but possibly not unpickled again. This is a technical requirement that may be relaxed in the future. Here's the sample: class FixedOffset(tzinfo): """Fixed offset in minutes east from UTC.""" def __init__(self, offset, name): self.__offset = timedelta(minutes = offset) self.__name = name def utcoffset(self, dt): return self.__offset This sample, if It's following the page's own advice, should have an __init__ method to support pickling which has no required parameters (except self, of course). Something like this: def __init__(self, offset_hours=0, offset_minutes=0, name=''): Of course, this may not be the right behavior either (e.g. might want to create a default name for the time zone based on hours & minutes) but at least by specifying default parameter values you avoid hard-to-troubleshoot exceptions at runtime like your existing sample did for me. :-) Thanks! Justin Grant jgrant(a)splunk.com<mailto:jgrant@splunk.com> | +1 415 848 8578 Splunk | Product Management

1 0

[issue10224] Build 3.x documentation using python3.x
by Georg Brandl Nov. 8, 2010

Nov. 8, 2010

Georg Brandl <georg(a)python.org> added the comment: I agree that 3.2 should eventually be independent of a 2.x Python. Since the "port to 3.x" part of Sphinx 1.1 is basically done, I might just do an early alpha release and use that for Doc/tools before 3.2 final. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10224> _______________________________________

1 0

[issue10224] Build 3.x documentation using python3.x
by Alexander Belopolsky Nov. 8, 2010

Nov. 8, 2010

Alexander Belopolsky <belopolsky(a)users.sourceforge.net> added the comment: As discussed on #python-dev, building 3.x documentation using python3.x will require Sphinx 1.1 which will not be released in time for 3.2. I am adding #10225 as a dependency because I feel that fixing actual errors in ReST doctests is more important than upgrading documentation tool chain. Hopefully this will bring more eyes to that issue. This said, I believe it is important for python-dev to "eat their own dogfood" and make 3.2 self-hosting. In other words, if we want to convince users that 3.x is ready, we should not require 2.x in the build process. Fortunately, Doc/tools is not shipped with python releases, so the transition can be made at any time regardless of python release schedule. ---------- dependencies: +Fix doctest runable examples in python manual stage: -> needs patch type: -> feature request _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10224> _______________________________________

1 0

[issue10225] Fix doctest runable examples in python manual
by Łukasz Langa Nov. 8, 2010

Nov. 8, 2010

Changes by Łukasz Langa <lukasz(a)langa.pl>: ---------- nosy: +lukasz.langa _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10225> _______________________________________

1 0