Products.CMFPlone/plip-1486-redirection: Add descriptive comment to method

Stephan Klinger <jenkins-z4DKO/[email protected]>
Newsgroups gmane.comp.web.zope.plone.cvs
Message-ID <[email protected]>
Repository: Products.CMFPlone
Branch: refs/heads/plip-1486-redirection
Date: 2017-07-10T09:31:40+03:00
Author: Stephan Klinger (staeff) <[email protected]>
Commit: https://github.com/plone/Products.CMFPlone/commit/b9132e614da830ed0d8dd7fe1a1cc2d457fe5239

Add descriptive comment to method

Files changed:
M Products/CMFPlone/controlpanel/browser/redirects.py

diff --git a/Products/CMFPlone/controlpanel/browser/redirects.py b/Products/CMFPlone/controlpanel/browser/redirects.py
index ecf4e7552..80e6cc795 100644
--- a/Products/CMFPlone/controlpanel/browser/redirects.py
+++ b/Products/CMFPlone/controlpanel/browser/redirects.py
@@ -173,6 +173,13 @@ def __init__(self, context, request):
         # list of tuples: (line_number, absolute_redirection_path, err_msg, target)
 
     def redirects(self):
+        """ Get existing redirects from the redirection storage.
+            Return dict with the strings redirect, path and redirect-to.
+            Strip the id of the instance from path and redirect-to if
+            it is present. (Seems to be always true)
+            If id of instance is not present in path the var 'path' and
+            'redirect' are equal.
+        """
         storage = getUtility(IRedirectionStorage)
         portal = getUtility(ISiteRoot)
         portal_path = "/".join(portal.getPhysicalPath())



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.