Homogenized doc headers

cs3org · Mar 2, 2022 · 24d4e2f · 24d4e2f
1 parent c01a1df
commit 24d4e2f
Show file tree

Hide file tree

Showing 14 changed files with 26 additions and 18 deletions.
diff --git a/src/bridge/__init__.py b/src/bridge/__init__.py
@@ -1,7 +1,7 @@
 '''
-The WOPI Bridge for IOP. This connector service supports CodiMD and Etherpad.
+The WOPI bridge extension for IOP. This connector service supports CodiMD and Etherpad.
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import os

diff --git a/src/bridge/codimd.py b/src/bridge/codimd.py
@@ -3,7 +3,7 @@
 
 The CodiMD-specific code used by the WOPI bridge.
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import os

diff --git a/src/bridge/etherpad.py b/src/bridge/etherpad.py
@@ -3,7 +3,7 @@
 
 The Etherpad-specific code used by the WOPI bridge.
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 from random import choice

diff --git a/src/bridge/wopiclient.py b/src/bridge/wopiclient.py
@@ -1,9 +1,9 @@
 '''
 wopiclient.py
 
-A set of WOPI functions for the WOPI bridge service.
+A set of WOPI client functions for the WOPI bridge service.
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import os

diff --git a/src/core/commoniface.py b/src/core/commoniface.py
@@ -4,7 +4,7 @@
 Common entities used by all storage interfaces for the IOP WOPI server.
 Includes functions to store and retrieve Reva-compatible locks.
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import time

diff --git a/src/core/cs3iface.py b/src/core/cs3iface.py
@@ -3,9 +3,7 @@
 
 CS3 API based interface for the IOP WOPI server
 
-Authors:
-Giuseppe.LoPresti@cern.ch, CERN/IT-ST
-Lovisa.Lugnegaard@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import time

diff --git a/src/core/discovery.py b/src/core/discovery.py
@@ -1,9 +1,12 @@
 '''
 discovery.py
 
-Helper code for the WOPI discovery phase, as well as
-for integrating the apps supported by the bridge functionality.
-This code is going to be deprecated once the new Reva AppProvider is fully functional.
+Helper code for the WOPI discovery phase, as well as for integrating the apps
+supported by the bridge functionality.
+This code is deprecated and is only used in conjunction with the xroot storage interface:
+when the WOPI server is interfaced to Reva via the cs3 storage interface this code is disabled.
+
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 from xml.etree import ElementTree as ET

diff --git a/src/core/ioplocks.py b/src/core/ioplocks.py
@@ -2,6 +2,8 @@
 ioplocks.py
 
 Implementation of the interoperable (iop) locking used for OnlyOffice and Office Desktop applications.
+
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import time

diff --git a/src/core/localiface.py b/src/core/localiface.py
@@ -3,7 +3,7 @@
 
 Local storage interface for the IOP WOPI server
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import time

diff --git a/src/core/wopi.py b/src/core/wopi.py
@@ -3,6 +3,8 @@
 srv.py
 
 Implementation of the core WOPI API
+
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import time

diff --git a/src/core/wopiutils.py b/src/core/wopiutils.py
@@ -1,7 +1,9 @@
 '''
 wopiutils.py
 
-General Low-level functions to support the WOPI server
+General low-level functions to support the WOPI server.
+
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import sys

diff --git a/src/core/xrootiface.py b/src/core/xrootiface.py
@@ -3,8 +3,7 @@
 
 eos-xrootd interface for the IOP WOPI server
 
-Author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
-Contributions: Michael.DSilva@aarnet.edu.au
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import time

diff --git a/src/wopiserver.py b/src/wopiserver.py
@@ -4,7 +4,7 @@
 
 The Web-application Open Platform Interface (WOPI) gateway for the ScienceMesh IOP
 
-Author: Giuseppe Lo Presti (@glpatcern), CERN/IT-ST
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 Contributions: see README.md
 '''
 

diff --git a/test/test_storageiface.py b/test/test_storageiface.py
@@ -4,6 +4,8 @@
 Basic unit testing of the storage interfaces. To run them, please make sure the
 wopiserver-test.conf is correctly configured (see /README.md). The storage layer
 to be tested can be overridden by the WOPI_STORAGE env variable.
+
+Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
 '''
 
 import unittest
-Original file line number
+Diff line change
@@ Expand Up / @@ -3,6 +3,8 @@ @@
     srv.py
     Implementation of the core WOPI API
+    Main author: Giuseppe.LoPresti@cern.ch, CERN/IT-ST
     '''
     import time
@@ Expand Down @@