changeset 909:fab49a1d5ea2

core: minor docstring fixes
author Goffi <goffi@goffi.org>
date Fri, 21 Mar 2014 15:03:51 +0100
parents 2ef523f0b5c3
children 9754c0ebadba
files src/core/sat_main.py src/memory/memory.py
diffstat 2 files changed, 6 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/src/core/sat_main.py	Tue Mar 18 13:52:12 2014 +0100
+++ b/src/core/sat_main.py	Fri Mar 21 15:03:51 2014 +0100
@@ -541,9 +541,8 @@
         return treatments
 
     def sendAndStoreMessage(self, mess_data, skip_send=False, profile=None):
-        """Actually send and store the message to history, after all the treatments
-        have been done. This has been moved outside the main sendMessage method
-        because it is used by XEP-0033 to complete a server-side feature not yet
+        """Actually send and store the message to history, after all the treatments have been done.
+        This has been moved outside the main sendMessage method because it is used by XEP-0033 to complete a server-side feature not yet
         implemented by the prosody plugin.
         @param mess_data: message data dictionary
         @param skip_send: set to True to skip sending the message to only store it
@@ -646,10 +645,10 @@
         """Discover if a server or its items offer a given feature
         @param feature: the feature to check
         @param jid_: the jid of the server, local server if None
-        @param cache_only: expect the result to be in cache and don't actually
-        make any request. This can be used anytime for requesting a feature on
-        the local server because the data are cached for sure.
+        @param cache_only: expect the result to be in cache and don't actually make any request.
+                           This can be used anytime for requesting a feature on the local server because the data are cached for sure.
         @result: the Deferred entity jid offering the feature, or None
+
         """
         profile = self.memory.getProfileName(profile_key)
 
--- a/src/memory/memory.py	Tue Mar 18 13:52:12 2014 +0100
+++ b/src/memory/memory.py	Fri Mar 21 15:03:51 2014 +0100
@@ -975,7 +975,7 @@
         """Tell if the specified server has the required feature
         @param feature: requested feature
         @param jid_: the jid of the target server (None for profile's server)
-        @param profile: which profile is asking this server?
+        @param profile_key: %(doc_profile_key)s
         """
         profile = self.getProfileName(profile_key)
         if not profile: