From d0c50e1436535e06b94b603842160634bc8c33be Mon Sep 17 00:00:00 2001 From: Ken'ichi Ohmichi Date: Tue, 20 Jun 2017 15:42:42 -0700 Subject: [PATCH] Add docstring for rcs, vcs modules This patch adds docstring to explain what rcs/vcs modules are clearly. Change-Id: Ie0904115f4feb47fb6e0da814204fd28326e316e --- stackalytics/processor/rcs.py | 2 ++ stackalytics/processor/vcs.py | 2 ++ 2 files changed, 4 insertions(+) diff --git a/stackalytics/processor/rcs.py b/stackalytics/processor/rcs.py index 155bd4c24..ef6631ff4 100644 --- a/stackalytics/processor/rcs.py +++ b/stackalytics/processor/rcs.py @@ -34,6 +34,8 @@ class RcsException(Exception): class Rcs(object): + """Base object for Review Control System""" + def __init__(self): pass diff --git a/stackalytics/processor/vcs.py b/stackalytics/processor/vcs.py index 227737d2f..bb98daf95 100644 --- a/stackalytics/processor/vcs.py +++ b/stackalytics/processor/vcs.py @@ -28,6 +28,8 @@ LOG = logging.getLogger(__name__) class Vcs(object): + """Base object for Version Control System""" + def __init__(self, repo, sources_root): self.repo = repo self.sources_root = sources_root