Skip to content

Commit

Permalink
Removed docstrings from some methods to avoid publishing them.
Browse files Browse the repository at this point in the history
From Products.PloneHotfix20160419.
  • Loading branch information
mauritsvanrees committed May 4, 2016
1 parent 5b6a967 commit 0a2d403
Show file tree
Hide file tree
Showing 4 changed files with 26 additions and 23 deletions.
3 changes: 3 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,9 @@ http://docs.zope.org/zope2/
Bugs Fixed
++++++++++

- Removed docstrings from some methods to avoid publishing them. From
Products.PloneHotfix20160419. [maurits]

- bobo_traverse of ProductDispatcher did not correctly invalidate cache
when a product was not initializes after first access of the cache. Types
that were added in test-profiles were not useable.
Expand Down
14 changes: 7 additions & 7 deletions src/OFS/Application.py
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ def getPhysicalRoot(self):
return self

def getPhysicalPath(self):
"""Get the physical path of the object.
Returns a path (an immutable sequence of strings) that can be used to
access this object again later, for example in a copy/paste operation.
getPhysicalRoot() and getPhysicalPath() are designed to operate
together.
"""
# Get the physical path of the object.
#
# Returns a path (an immutable sequence of strings) that can be used to
# access this object again later, for example in a copy/paste
# operation. getPhysicalRoot() and getPhysicalPath() are designed to
# operate together.
#
# We're at the base of the path.
return ('', )

Expand Down
14 changes: 7 additions & 7 deletions src/OFS/SimpleItem.py
Original file line number Diff line number Diff line change
Expand Up @@ -241,7 +241,7 @@ def raise_standardErrorMessage(
try:
strv = repr(error_value) # quotes tainted strings
except:
strv = ('<unprintable %s object>' %
strv = ('<unprintable %s object>' %
str(type(error_value).__name__))
v = strv + (
(" (Also, the following error occurred while attempting "
Expand Down Expand Up @@ -406,13 +406,13 @@ def _setId(self, id):
self.__name__=id

def getPhysicalPath(self):
"""Get the physical path of the object.
# Get the physical path of the object.
#
# Returns a path (an immutable sequence of strings) that can be used to
# access this object again later, for example in a copy/paste
# operation. getPhysicalRoot() and getPhysicalPath() are designed to
# operate together.

Returns a path (an immutable sequence of strings) that can be used to
access this object again later, for example in a copy/paste operation.
getPhysicalRoot() and getPhysicalPath() are designed to operate
together.
"""
path = (self.__name__, )
p = aq_parent(aq_inner(self))
if p is not None:
Expand Down
18 changes: 9 additions & 9 deletions src/OFS/Traversable.py
Original file line number Diff line number Diff line change
Expand Up @@ -108,15 +108,15 @@ def virtual_url_path(self):

security.declarePublic('getPhysicalPath')
def getPhysicalPath(self):
"""Get the physical path of the object.
Returns a path (an immutable sequence of strings) that can be used to
access this object again later, for example in a copy/paste operation.
getPhysicalRoot() and getPhysicalPath() are designed to operate
together.
This implementation is optimized to avoid excessive amounts of function
calls while walking up from an object on a deep level.
# Get the physical path of the object.
#
# Returns a path (an immutable sequence of strings) that can be used to
# access this object again later, for example in a copy/paste
# operation. getPhysicalRoot() and getPhysicalPath() are designed to
# operate together.

# This implementation is optimized to avoid excessive amounts of
# function calls while walking up from an object on a deep level.
"""
try:
id = self.id or self.getId()
Expand Down

0 comments on commit 0a2d403

Please sign in to comment.