doc: BasicScripting: method names should be inlined

Bug #435159 reported by NicDumZ
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Zope 2
Fix Released
Undecided
Tres Seaver

Bug Description

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

Revision history for this message
NicDumZ (nicdumz) wrote :

And here's a patch.

Revision history for this message
Tres Seaver (tseaver) wrote :

For future reference, a "unified diff" would be a lot easier to evaluate apply. For tips on generating such a diff from a read-only SVN checkout, please see:

  http://docs.zope.org/developer/noncommitter-svn.html#how-to-submit-a-patch-from-your-subversion-checkout

Revision history for this message
Tres Seaver (tseaver) wrote :

Thanks for the patch. I have applied it to the trunk of the zope2book checkout. See:

  http://svn.zope.org/zope2docs/trunk/?rev=112178&view=rev

It should show up online after the periodic sync job runs.

Changed in zope2:
assignee: nobody → Tres Seaver (tseaver)
status: New → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.