[Python-bugs-list] [ python-Bugs-493243 ] ext call doco warts

noreply@sourceforge.net noreply@sourceforge.net
Fri, 14 Jun 2002 07:24:49 -0700


Bugs item #493243, was opened at 2001-12-14 05:22
You can respond by visiting: 
http://sourceforge.net/tracker/?func=detail&atid=105470&aid=493243&group_id=5470

Category: Documentation
Group: None
Status: Open
Resolution: None
>Priority: 6
Submitted By: Michael Hudson (mwh)
Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: ext call doco warts

Initial Comment:
Now they've been compiled <wink>, I notice that there
are some warts in my docs for the *- and **-style call
syntax.

1) the "argument_list" production is really, really
confusing.  there must be a better BNF-style way of
saying that.  I don't think vertically centering the
production name against the production helps.

2) For some reason, where I say

It is unusual for both keyword arguments and the
"*expression"syntax to be used in the same call, so in
practice this confusion does not arise.

there's no space between `"*expression"' and `syntax'.
 I'd guess that this is because in the source, the
\samp{} macro is the last thing on the line, but why
that should lead to a missing space is beyond me --
more latex2html bugs?

(just noticed the same thing a bit higher up too -- 

the "**expression"argument, if any 

No hurry with these.

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

>Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2002-06-14 10:24

Message:
Logged In: YES 
user_id=3066

Bumped priority; needs review.

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

Comment By: Michael Hudson (mwh)
Date: 2002-06-14 10:09

Message:
Logged In: YES 
user_id=6656

I'm going to check my fix in unless someone complains *real*
soon.

At least I know it compiles now, and I think it's an
improvement.

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

Comment By: Michael Hudson (mwh)
Date: 2001-12-20 09:25

Message:
Logged In: YES 
user_id=6656

Another problem with the pseudo-EBNF: it's wrong.  Oops.

It suggests that f(a, **b) isn't legal, for example.

I've attached an attempt I think it right, but I'm not sure 
and haven't compiled it (& so don't know if it looks any less 
confusing than last time).


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

Comment By: Fred L. Drake, Jr. (fdrake)
Date: 2001-12-14 12:01

Message:
Logged In: YES 
user_id=3066

Fixed table cell alignment in Doc/perl/python.perl revision
1.115.

Fixed item 2:  Worked around spaces problem in
Doc/ref/ref5.tex 1.53

This bug remains open; I still need to address the basic
problem in item 1 (confusing pseudo-EBNF).

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

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