From 2233ad8fc353973f0dd396d4df1f95eaf7262c97 Mon Sep 17 00:00:00 2001
From: Chandrasekhar Ramakrishnan <chandrasekhar.ramakrishnan@id.ethz.ch>
Date: Fri, 17 Mar 2017 11:01:45 +0100
Subject: [PATCH] MINOR: Improved method documentation.
---
src/python/OBis/obis/dm/data_mgmt.py | 15 +++++++++++----
1 file changed, 11 insertions(+), 4 deletions(-)
diff --git a/src/python/OBis/obis/dm/data_mgmt.py b/src/python/OBis/obis/dm/data_mgmt.py
index 9386dfa5de3..5e092138445 100644
--- a/src/python/OBis/obis/dm/data_mgmt.py
+++ b/src/python/OBis/obis/dm/data_mgmt.py
@@ -166,12 +166,19 @@ class AbstractDataMgmt(metaclass=abc.ABCMeta):
@abc.abstractmethod
def init_data(self, path, desc=None):
- """Initialize a data repository at the path with the description."""
+ """Initialize a data repository at the path with the description.
+ :param path: Path for the repository.
+ :param desc: An optional short description of the repository (used by git-annex)
+ :return: A CommandResult.
+ """
return
@abc.abstractmethod
def init_analysis(self, path):
- """Initialize an analysis repository at the path."""
+ """Initialize an analysis repository at the path.
+ :param path: Path for the repository.
+ :return: A CommandResult.
+ """
return
@abc.abstractmethod
@@ -183,7 +190,7 @@ class AbstractDataMgmt(metaclass=abc.ABCMeta):
:param msg: Commit message.
:param auto_add: Automatically add all files in the folder to the repo. Defaults to True.
:param sync: If true, sync with openBIS server.
- :return:
+ :return: A CommandResult.
"""
return
@@ -193,7 +200,7 @@ class AbstractDataMgmt(metaclass=abc.ABCMeta):
Sync the current repo.
This connects to openBIS and creates a data set in openBIS.
- :return:
+ :return: A CommandResult.
"""
return
--
GitLab