[zope2-tracker] [Bug 435159] [NEW] doc: BasicScripting: method names should be inlined

NicDumZ nicdumz at gmail.com
Wed Sep 23 06:13:04 EDT 2009


Public bug reported:

reST extract:

"""
returning it manually, rather than relying on the::

  print

statement.
"""

It would be better to write this as:
"""
returning it manually, rather than relying on the ``print`` statement.
"""

for readability. This happens several times. Later on, we have:

"""
to check if::

  foo

is a list
"""

And the terribly hard to read:
"""
Note that::

  context.hello_world_pt

works because there is no dot in the id of the template. In Python, dots are
used to separate ids. This is the reason why Zope often uses ids like::

  index_html

instead of the more common::

  index.html

and why this example uses::

  hello_world_pt

instead of::

  hello_world.pt
"""

and so on...

** Affects: zope2
     Importance: Undecided
         Status: New

-- 
doc: BasicScripting: method names should be inlined
https://bugs.launchpad.net/bugs/435159
You received this bug notification because you are a member of Zope 2
Developers, which is subscribed to Zope 2.


More information about the zope2-tracker mailing list