plugin upload: minor fixes in some docstring length
This commit is contained in:
parent
9335194f7b
commit
3c41ade548
1 changed files with 8 additions and 6 deletions
|
|
@ -84,7 +84,8 @@ class UploadPlugin(object):
|
|||
"""Send a file using best available method
|
||||
|
||||
parameters are the same as for [upload]
|
||||
@return (dict): action dictionary, with progress id in case of success, else xmlui message
|
||||
@return (dict): action dictionary, with progress id in case of success, else xmlui
|
||||
message
|
||||
"""
|
||||
|
||||
def uploadCb(data):
|
||||
|
|
@ -123,8 +124,8 @@ class UploadPlugin(object):
|
|||
- ignore_tls_errors(bool): True to ignore SSL/TLS certificate verification
|
||||
used only if HTTPS transport is needed
|
||||
@param profile: %(doc_profile)s
|
||||
@return (tuple[unicode,D(unicode)]): progress_id and a Deferred which fire download URL
|
||||
when upload is finished
|
||||
@return (tuple[unicode,D(unicode)]): progress_id and a Deferred which fire
|
||||
download URL when upload is finished
|
||||
"""
|
||||
if options is None:
|
||||
options = {}
|
||||
|
|
@ -153,12 +154,13 @@ class UploadPlugin(object):
|
|||
@param method_name(unicode): short name for the method, must be unique
|
||||
@param available_cb(callable): method to call to check if this method is usable
|
||||
the callback must take two arguments: upload_jid (can be None) and profile
|
||||
the callback must return the first entity found (being upload_jid or one of its components)
|
||||
the callback must return the first entity found (being upload_jid or one of its
|
||||
components)
|
||||
exceptions.NotFound must be raised if no entity has been found
|
||||
@param upload_cb(callable): method to upload a file
|
||||
must have the same signature as [fileUpload]
|
||||
must return a tuple with progress_id and a Deferred which fire download URL when
|
||||
upload is finished
|
||||
must return a tuple with progress_id and a Deferred which fire download URL
|
||||
when upload is finished
|
||||
@param priority(int): pririoty of this method, the higher available will be used
|
||||
"""
|
||||
assert method_name
|
||||
|
|
|
|||
Loading…
Reference in a new issue