Mailman 3 April 2013 - docs

[issue17583] IDLE HOWTO
by Todd Rovito April 1, 2013

April 1, 2013

Todd Rovito added the comment: Sorry about using the wrong word, I should of used HowTo not FAQ. I really meant to suggest replacing guide with the word HowTo. A HowTo would be perfect!!!! Sorry about the confusion. Thanks again. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17583> _______________________________________

1 0

Re: [docs] Improve the "introduction" page of the tutorial (issue 14097)
by ezio.melotti＠gmail.com April 1, 2013

April 1, 2013

http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst File Doc/tutorial/introduction.rst (left): http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:294: >>> word[:2] # The first two characters Most of these examples have been reorganized to introduce the concept more gradually. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:412: About Unicode I think this can be postponed until bytes are introduced. Maybe it should be mentioned briefly that strings support Unicode though. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:551: object! We'll come back to *object semantics* later. This is a fundamental concept, and this lighthearted introduction only serves to add more confusion IMHO. I removed the example for now, but this should be covered at a later point. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst File Doc/tutorial/introduction.rst (right): http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:203: 'unununium' All the changes from this point onward are new in this patch, the previous patch didn't include any of these. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:232: Double empty line. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:235: :: This can be moved at the end of the previous sentence; also the previous line is too long. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:280: One way to remember how slices work is to think of the indices as pointing While this is useful for slicing, it doesn't work too well for indexing, where placing the index *below* (rather than *in between*) works better. Should I show both the examples? http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:286: | H | e | l | p | A | The sample text should be changed. http://bugs.python.org/review/14097/diff/7743/Doc/tutorial/introduction.rst… Doc/tutorial/introduction.rst:514: >>> while b < 1000: This still needs to be changed, but I'm not sure how yet. I think it would be best to introduce "if" and "for" first, but this is done in the next page IIRC, so it might be better to move this whole example in the next page. http://bugs.python.org/review/14097/

1 0

[issue17583] IDLE HOWTO
by Amit Saha April 1, 2013

April 1, 2013

Amit Saha added the comment: Thanks Ezio. I am almost done with incorporating the changes suggested and will submit a patch sometime in the next day or so. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17583> _______________________________________

1 0

[issue17583] IDLE HOWTO
by Ezio Melotti April 1, 2013

April 1, 2013

Ezio Melotti added the comment: I added a few more comments. To clarify, when I said two documents, I meant that there will be only a single HOWTO, but on 2.7 it will be specific to Python 2, whereas on 3.x it will be specific to Python 3. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17583> _______________________________________

1 0

Re: [docs] IDLE HOWTO (issue 17583)
by ezio.melotti＠gmail.com April 1, 2013

April 1, 2013

http://bugs.python.org/review/17583/diff/7736/Doc/howto/idle.rst File Doc/howto/idle.rst (right): http://bugs.python.org/review/17583/diff/7736/Doc/howto/idle.rst#newcode4 Doc/howto/idle.rst:4: In this guide, we take a look at the basic features of `IDLE` On 2013/04/01 04:17:46, Todd.Rovito wrote: > I would replace the word "guide" with FAQ throughout the document because you > are adding a new FAQ after all right? This looks more like a guide/howto to me. http://bugs.python.org/review/17583/diff/7736/Doc/howto/idle.rst#newcode6 Doc/howto/idle.rst:6: are suitable for a new Python programmer. The scope of this document On 2013/04/01 04:17:46, Todd.Rovito wrote: > which is suitable for a beginner Python programmer. which is suitable for beginner Python programmers. http://bugs.python.org/review/17583/diff/7736/Doc/howto/idle.rst#newcode8 Doc/howto/idle.rst:8: write programs using the editor and running it. On 2013/04/01 04:17:46, Todd.Rovito wrote: > The scope of this document is intentionally limited to demonstrate the use of > the IDLE editor to create Python programs then run those programs in the IDLE > shell. This sentence will get outdated as soon as new things will be added, so it could either be removed, or replaced with something a little more vague (e.g. "This document is only meant to provide a basic introduction to IDLE features."). http://bugs.python.org/review/17583/

1 0

[issue1944] Documentation for PyUnicode_AsString (et al.) missing.
by Mark Lawrence April 1, 2013

April 1, 2013

Mark Lawrence added the comment: Is it worth applying the patch given the complete rewrite of unicode for 3.3 via PEP393? ---------- nosy: +BreamoreBoy _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue1944> _______________________________________

2 1

[issue7057] tkinter doc: more 3.x updates
by Ned Deily April 1, 2013

April 1, 2013

Ned Deily added the comment: I just noticed that the changes committed earlier for this issue added a reference to the Tcl/Tk 8.6 man pages. Since there are known problems with using 8.6 with tkinter (for example, Issue16809) and we don't currently ship 8.6 with any of our binary installers, it would be better to reference the 8.5 man pages until the status of 8.6 support is resolved. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue7057> _______________________________________

1 0

[issue17586] fix typo in contextlib.rst
by Roundup Robot April 1, 2013

April 1, 2013

New submission from Roundup Robot: New changeset 18e699c4d8c0 by Ned Deily in branch 'default': Issue #17586: fix typo in contextlib.rst http://hg.python.org/cpython/rev/18e699c4d8c0 ---------- nosy: +python-dev _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17586> _______________________________________

4 3

[issue17583] IDLE HOWTO
by Amit Saha March 31, 2013

March 31, 2013

Amit Saha added the comment: Hi Todd, thanks for your comments. I wanted to clarify that I intend to make this a HOWTO, not a FAQ. I hope that's fine? -Amit. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17583> _______________________________________

1 0

[issue17583] IDLE HOWTO
by Todd Rovito March 31, 2013

March 31, 2013

Todd Rovito added the comment: Ezio, I left a few comments on rietveld. This is a really nice start to a great FAQ. Thanks for your contribution I think Python needs a nice FAQ on IDLE. You might want to add some detail about the right click menu which allows a user to cut, copy, paste, and set breakpoints. I think a section on the debugger would be excellent. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17583> _______________________________________

1 0