This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

Title: Glossary
Type: Stage:
Components: Documentation Versions: Python 2.3
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: fdrake Nosy List: duncanb, fdrake, rhettinger, skip.montanaro
Priority: high Keywords: patch

Created on 2003-08-14 04:04 by skip.montanaro, last changed 2022-04-10 16:10 by admin. This issue is now closed.

File name Uploaded Description Edit
ref.diff skip.montanaro, 2003-08-14 04:04
Messages (11)
msg44453 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2003-08-14 04:04
The topic of iterables came up on recently.  One 
of the participants mentioned that "iterable" isn't listed
in the index of either the language or library reference
manuals.  A quick search didn't yield any obvious 
definition of what an iterable is.  (There may be something
I missed.  I wasn't terribly thorough in my search.)

The attached patch attempts to fix that omission by adding
a glossary to the language reference manual.  Maybe it 
should be a separate manual.  It doesn't seem like it
belongs in the tutorial, and the library reference manual
doesn't cover the language itself.

Keep, toss, throw darts at, or pass back for action.

msg44454 - (view) Author: Duncan Booth (duncanb) Date: 2003-08-14 08:33
Logged In: YES 

Sorry, but I'm going to throw darts at this. You need to have 
glossary entries for both 'iterable' and 'iterator', and you're 
current definition of 'iterable' is actually the definition 
of 'iterator' not of 'iterable'.

Try something like this:

\item[iterable] Any object which supports enumeration of a 
set of values by calling its \method{__iter__} which returns 
an iterator over those values. Examples include \class{file},
\class{list} and \class{dict} objects.  In the case of \class
{dict} objects, iteration is over the keys in the object.

\item[iterator] An object which supports enumeration of a
set of values by calling its \method{next} method and which
contains an \method{__iter__} method which returns the
object itself.  Examples: \class{file} is a iterable which is its 
own iterator. \class{list} and \class{dict} are iterables which 
create iterators of types which are not otherwise visible.
msg44455 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2003-08-14 13:29
Logged In: YES 

Agreed.  Any glossary with only one entry would be a bit thin.
Thanks for the new entry. :-)
msg44456 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2003-09-17 05:20
Logged In: YES 

The wiki was a success and the glossary looks ready for 
prime-time.  So go ahead and add it (or assign to me).
msg44457 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2003-09-17 14:50
Logged In: YES 

Agreed, it has been quite successful.  Fred,  I'll take this over
if you like, but I'd sort of like a pronouncement about where
the glossary should go.  My thought was that it would be an
appendix to the language reference manual.
msg44458 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2003-09-17 15:45
Logged In: YES 

I recommend putting it in the tutorial.  As it stands now, the 
glossary can be profitability read A to Z after completing the 
tutorial.  It can serve to unify and solidify the ideas 
presented up to that point.

The reference manual is more encyclopedic and I think the 
glossary would be lost in a sea of entries.

Another alternative is to make it a stand-alone link from the 
main page:
     Tutorial (start here)        Ref Manual
     Lib Ref                           Glossary of Key Concepts

This patch is marked for Py2.4.  I recommend that it be 
added to Py2.3.1 also.
msg44459 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2003-09-24 13:09
Logged In: YES 

I'm going to put this in the tutorial as Raymond suggested.  It
would be nice if there was a special \glossaryitem{} environment
that would allow easy linking to glossary entries from other
places in the documentation.  I'm not going to let its absence
hold me up.  It's just something to consider.
msg44460 - (view) Author: Skip Montanaro (skip.montanaro) * (Python triager) Date: 2003-09-24 17:01
Logged In: YES 

I checked in an initial glossary for the tutorial.  I'm sure it will 
need a fair amount of LaTeX work.  Fred, please feel free to
ping me on that.  I will be happy to do the work with some
guidance from you.  One thing I was hoping we could do is
generate links from other documentation into the tutorial, but
I have no idea how well LaTeX and latex2html support inter-
document links.  Another (simpler, though tedious) task will
be to "indexify" the tutorial, now that one is being generated.
msg44461 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2003-09-28 07:37
Logged In: YES 

Now, the hyperlinks need to be fixed.  They are all relative
to the tutorial directory.

Also, consider backporting the glossary to 2.3.2.
msg44462 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-09-29 14:29
Logged In: YES 

The hyperlinks are now fixed.  It's up to Skip if he wants
to maintain a version of this in 2.3.x, but too late for 2.3.2.

Skip, please close this when you're satisfied (with the
state of the glossary).
msg44463 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2003-12-19 15:15
Logged In: YES 

The glossary is now part of the 2.3.x and 2.4 trees; closing
this issue.
Date User Action Args
2022-04-10 16:10:38adminsetgithub: 39064
2003-08-14 04:04:37skip.montanarocreate