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.

classification
Title: "appropriately decorated" is undefined in MultiFile.push doc
Type: Stage:
Components: Documentation Versions: Python 2.4
process
Status: closed Resolution: accepted
Dependencies: Superseder:
Assigned To: Nosy List: aisaac0, georg.brandl, pterk, terry.reedy
Priority: normal Keywords:

Created on 2005-08-09 19:07 by aisaac0, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (5)
msg26002 - (view) Author: Alan (aisaac0) Date: 2005-08-09 19:07
At http://docs.python.org/lib/MultiFile-objects.html we
read:

push(  str)
    Push a boundary string. When an appropriately
decorated version of this boundary is found as an input
line, it will be interpreted as a section-divider or
end-marker. ...

But this presumes that "appropriately decorated" is
understood, which it won't be until multifile is
understood.

How about following that sentence with something like:
(Appropriate decoration is determined by the
section_divider and 
end_marker methods.)

msg26003 - (view) Author: Terry J. Reedy (terry.reedy) * (Python committer) Date: 2005-08-11 17:11
Logged In: YES 
user_id=593130

I agree that the sentence is confusing in its appropriate context.  
An alternative to the forward reference to the section_divider and 
end_marker methods is to move the entries for those methods 
just above the entry for the push method.
msg26004 - (view) Author: Alan (aisaac0) Date: 2005-08-11 20:58
Logged In: YES 
user_id=1025672

IMO that works only if the term "appropriate decoration"
occurs (appropriately) in those sections.  And if it does,
the relative location is  probably irrelevant.

This is really a problem of undefined terminology.
msg26005 - (view) Author: Peter van Kampen (pterk) Date: 2005-10-17 10:06
Logged In: YES 
user_id=174455

I commited a patch so the sentence reads:

Push a boundary string.  When the boundary is found as an
input line, it will be interpreted as a section-divider or
end-marker (depending on the boundary decoration. See
\rfc{2045}).

See patch:
http://sourceforge.net/tracker/index.php?func=detail&aid=1328526&group_id=5470&atid=305470
msg26006 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2005-11-22 19:44
Logged In: YES 
user_id=1188172

Thanks! Committed in rev 41517, 41518 (2.4).
History
Date User Action Args
2022-04-11 14:56:12adminsetgithub: 42264
2005-08-09 19:07:12aisaac0create