[Doc-SIG] which characters to use for docstring markup

Edward D. Loper edloper@gradient.cis.upenn.edu
Wed, 11 Apr 2001 13:22:21 EDT


> I guess because I feel that dict displays are probably more common
> than comparisons -- but I haven't made a study.

The fact that only 13 '{'s appear in the reference docs I searched
suggests otherwise.. ;) But really, the question isn't how often dicts
are included, but how often they're included inline.  I would *think*
that dictionary displays tend not to be inline.. But I don't trust my
intuitions on such things, though..

> The argument could be made, though, that inside C{}, one could allow
> unescaped {} to *nest*, and this would make C{{'1': 2, '2': 1}}
> unambiguous.  We can't do this for < and >, because they occur
> unpaired much more often than } and {.

We'd want to be careful with this, but that could work.

> (My other reason was that I thought that C{} would be harder to type
> than C<>, but I can't find an objective reason for that.)

Which is something I hadn't considered, but is actually a fairly good
reason..  It *is* easier to type C<> than to type C{} (for me anyway),
since '<' and '>' are closer to the home row than '{' and '}'.. :)

I think I'm still leaning towards '{}', but I'm not strongly set on
it..  For now, I'll just remain uncommitted, until I've finished
implementing something, and we can play with them and see which one
looks/feels better.

-Edward