Re: [Python-Dev] [development doc updates]
Hi Fred, I wasn't aware of how it would be formatted when I submitted my PyObject_RichCompare patches. I think the different italic "op" usages are too similar. Probably \emph should be replaced with something that bold-ifies. Best, Dave ----- Original Message ----- From: "Fred L. Drake" <fdrake@acm.org> To: <python-dev@python.org>; <doc-sig@python.org>; <python-list@python.org> Sent: Friday, June 14, 2002 8:20 AM Subject: [Python-Dev] [development doc updates]
The development version of the documentation has been updated:
http://www.python.org/dev/doc/devel/
Updated to reflect recent changes.
_______________________________________________ Python-Dev mailing list Python-Dev@python.org http://mail.python.org/mailman/listinfo/python-dev
David Abrahams writes:
I wasn't aware of how it would be formatted when I submitted my PyObject_RichCompare patches. I think the different italic "op" usages are too similar. Probably \emph should be replaced with something that bold-ifies.
Bold is the wrong thing. I propose: - change the argument name to "opid" - let the "op" stand-in show in the code font so it contrasts with the o1 and o2 references in the \samp. Here's what it looks like: http://www.python.org/dev/doc/devel/api/object.html#l2h-170 If that works for you, let me know and I'll update the 2.2.x docs and commit the changes. Thanks for your comments! -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> PythonLabs at Zope Corporation
That's great, Fred. You might also want to add the "Return value: New reference." riff to PyObject_RichCompare; I missed that when looking at the existing doc for examples. -Dave From: "Fred L. Drake, Jr." <fdrake@acm.org>
David Abrahams writes:
I wasn't aware of how it would be formatted when I submitted my PyObject_RichCompare patches. I think the different italic "op" usages
are
too similar. Probably \emph should be replaced with something that bold-ifies.
Bold is the wrong thing. I propose:
- change the argument name to "opid" - let the "op" stand-in show in the code font so it contrasts with the o1 and o2 references in the \samp.
Here's what it looks like:
http://www.python.org/dev/doc/devel/api/object.html#l2h-170
If that works for you, let me know and I'll update the 2.2.x docs and commit the changes.
Thanks for your comments!
-Fred
-- Fred L. Drake, Jr. <fdrake at acm.org> PythonLabs at Zope Corporation
David Abrahams writes:
That's great, Fred. You might also want to add the "Return value: New reference." riff to PyObject_RichCompare; I missed that when looking at the existing doc for examples.
The mechanics of the refcount data are a bit different. I've added that and committed the changes; updates should appear on the site in the next hour. -Fred -- Fred L. Drake, Jr. <fdrake at acm.org> PythonLabs at Zope Corporation
participants (2)
-
David Abrahams
-
Fred L. Drake, Jr.