[ python-Bugs-1255218 ] "appropriately decorated" is undefined in MultiFile.push doc

[SourceForge.net]

Bugs item #1255218, was opened at 2005-08-09 15:07
Message generated for change (Comment added) made by tjreedy
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1255218&group_id=5470

Please note that this message will contain a full copy of the comment thread,
including the initial issue submission, for this request,
not just the latest update.
Category: Documentation
Group: Python 2.4
Status: Open
Resolution: None
Priority: 5
Submitted By: Alan (aisaac0)
Assigned to: Nobody/Anonymous (nobody)
Summary: "appropriately decorated" is undefined in MultiFile.push doc

Initial Comment:
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.)



----------------------------------------------------------------------

>Comment By: Terry J. Reedy (tjreedy)
Date: 2005-08-11 13:11

Message:
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.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=1255218&group_id=5470