Changes by Nick Coghlan ncogh...@gmail.com:
--
assignee: - ncoghlan
versions: -Python 3.2
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
Roundup Robot added the comment:
New changeset 463f52d20314 by Nick Coghlan in branch 'default':
Close #4966: revamp the sequence docs in order to better explain the state of
modern Python
http://hg.python.org/cpython/rev/463f52d20314
--
nosy: +python-dev
resolution: - fixed
stage:
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
versions: +Python 3.4
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Changes by Tshepang Lekhonkhobe tshep...@gmail.com:
--
keywords: +patch
Added file: http://bugs.python.org/file24511/0a49f6382467.diff
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
Nick Coghlan ncogh...@gmail.com added the comment:
Just noting that this has slipped a bit down my Python to-do list (there are
other things I want to focus on before the first 3.3 alpha).
I'll get back to it at some point, but if someone want to take my branch and
run with it in the
Nick Coghlan ncogh...@gmail.com added the comment:
Good point, without doing the split in both, any doc merges in this section
will be a nightmare. OK, with the caveat that the initial 3.2 version may gloss
over some issues that no longer apply in 3.3 (specifically the narrow/wide
split),
Ezio Melotti ezio.melo...@gmail.com added the comment:
One other point... the branch is actually now relative to default, not
3.2. While that was due to a merging mistake on my part, it also means
I can legitimately ignore the narrow/wide build distinction in the
section on strings.
So will
Nick Coghlan ncogh...@gmail.com added the comment:
Trying to make this change in 2.7 would actually be a bit of a nightmare - how
do you cleanly split documentation of the binary data and text processing
sequence types when str is used for both?
The change would be *mostly* feasible in 3.2
Terry J. Reedy tjre...@udel.edu added the comment:
I agree with 3.3 only. This might not be ready for 3.2.3 anyway, depending on
how soon hash patch is ready, and if not, it becomes a somewhat moot point as
new people should then download 3.3.0 instead of 3.2.4 next August.
--
Georg Brandl ge...@python.org added the comment:
ISTM that not doing this will make maintenance harder. For 2.7 I agree that
there is no clear boundary to make, but 3.2 should be split up as well to ease
merging of updates.
--
___
Python tracker
Nick Coghlan ncogh...@gmail.com added the comment:
One other point... the branch is actually now relative to default, not 3.2.
While that was due to a merging mistake on my part, it also means I can
legitimately ignore the narrow/wide build distinction in the section on strings.
--
Nick Coghlan ncogh...@gmail.com added the comment:
I finished off the binary data section, so the first draft of the update is now
complete in the bitbucket repo.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
Nick Coghlan ncogh...@gmail.com added the comment:
Branch status update:
- Text Sequence Types section updated to reflect the new structure
- changed the prose that describes the relationship between printf-style
formatting and the str.format method (deliberately removing the implication
that
Nick Coghlan ncogh...@gmail.com added the comment:
One other things the branch doesn't currently sort out is the official
signature of count() and index().
In 3.2, for *all* of str, bytes, bytearray, tuple, list, range, the index()
method takes the optional start:stop parameters.
Ezio Melotti ezio.melo...@gmail.com added the comment:
Have you considered/planned to rework a bit the beginning of the page too?
(Technically the issue is about the Sequence types section, but the whole page
could be improved.)
IMHO the sections about Truth value testing, Boolean operations,
Nick Coghlan ncogh...@gmail.com added the comment:
Yeah, the basic layout of this entire section has been in place for a *long*
time
(http://docs.python.org/release/1.4/lib/node4.html#SECTION0031)
Some aspects haven't really aged all that well, as people have made minimalist
Nick Coghlan ncogh...@gmail.com added the comment:
I realised that the lack of a clear binary/text distinction would make it messy
to do the split docs in 2.7, so I made a new branch based on 3.2 instead (link
to repo updated accordingly).
--
assignee: eric.araujo - ncoghlan
Nick Coghlan ncogh...@gmail.com added the comment:
Pushed an initial cut to my sandbox branch. Built HTML is attached so you can
get a general idea of how it looks (links, etc, obviously won't work).
So far, I have made the split into 3 sections and updated the new (shorter)
Sequence Types
Nick Coghlan ncogh...@gmail.com added the comment:
Note: without the Python docs CSS to create the sidebar, the internal table of
contents appears at the *bottom* of the rendered page.
Really, reviewing this sensibly is probably going to require building the docs
locally after using hg pull
Georg Brandl ge...@python.org added the comment:
+1 for splitting.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Python-bugs-list
Raymond Hettinger raymond.hettin...@gmail.com added the comment:
+1 for Nick's suggested breakout:
4.6 Sequence Types - list, tuple, range
4.7 Text Sequence Type - str
4.8 Binary Data Sequence Types - bytes, bytearray, memoryview
--
nosy: +rhettinger
Nick Coghlan ncogh...@gmail.com added the comment:
Éric, are you still planning to work on this? Otherwise I'll make a first pass
at doing the split into 3 sections (as per my earlier comment) and implementing
some of Terry's suggestions.
Linked Hg repo is a 2.7 based feature branch where
Ezio Melotti ezio.melo...@gmail.com added the comment:
Éric is without Internet till the end of the month, so I think it's OK if you
go ahead and start working on this.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
versions: -Python 3.1
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Nick Coghlan ncogh...@gmail.com added the comment:
Bringing a suggestion over from #12874, I think it may be worth splitting the
current Sequence Types section into 3 pieces that all appear in the top level
table of contents for the library reference:
4.6 Sequence Types - list, tuple, range
Ana Sofia Paixão anasofiapai...@gmail.com added the comment:
I was taking a look into the possibility of splitting this page into several
pages, and wondered: could the contents of the Comparisons and the Boolean
operations sections just be merged into Python Reference / Expressions, and
then
Ezio Melotti ezio.melo...@gmail.com added the comment:
I think it should be OK. The stdtypes page could then mention type-specific
behavior in the types' sections (e.g. , =, =, for sets) and link to the
language reference for the general behavior.
--
Ezio Melotti ezio.melo...@gmail.com added the comment:
See also #11975 and #11976.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Ezio Melotti ezio.melo...@gmail.com added the comment:
This is maybe out of the scope of this issue, but I would like to see all the
basic data types on single page on their own. The current page[0] has some
section about data types mixed with sections about operations, comparisons, and
Terry J. Reedy tjre...@udel.edu added the comment:
I have started learning .rst, so I hope to work on this in the not too distant
future.
Ezio -- I have also noticed that some chapters are too long to be easily
scrolled around in (unittest is another), and either need an index at the top
Ezio Melotti ezio.melo...@gmail.com added the comment:
The advantage of having one big page is that you can ctrl+f easily without
having to go back and forth from different pages
On the other hand, the page is not easy to browse (especially on small screens,
mobile devices, old/slow pcs).
In
Changes by Terry J. Reedy tjre...@udel.edu:
--
versions: +Python 3.3
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Python-bugs-list
Éric Araujo mer...@netwok.org added the comment:
I’m interested in making a series of patches corresponding to your suggestions,
unless you or someone else want to do them.
I’m assigning to myself so that I don’t forget (I won’t have time for a couple
weeks), if someone wants to do it as an
Terry J. Reedy tjre...@udel.edu added the comment:
Please go ahead. I will gladly review anything you do.
--
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
Changes by Mark Lawrence breamore...@yahoo.co.uk:
--
assignee: georg.brandl - d...@python
nosy: +d...@python
versions: +Python 3.2 -Python 3.0, Python 3.1
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
Changes by Terry J. Reedy tjre...@udel.edu:
--
versions: +Python 3.1
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Python-bugs-list
Changes by Ezio Melotti ezio.melo...@gmail.com:
--
nosy: +ezio.melotti
priority: - normal
stage: - needs patch
type: - feature request
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
Changes by Dennis Benzinger dennis.benzin...@gmx.net:
--
nosy: +dcbbcd
___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue4966
___
___
Python-bugs-list
38 matches
Mail list logo
