Skip to content

Commit

Permalink
docs: documentation creation fix
Browse files Browse the repository at this point in the history
  • Loading branch information
fstagni committed Sep 12, 2024
1 parent 1252509 commit 5292180
Showing 1 changed file with 9 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ def initializeHandler(cls, svcInfoDict):
@deprecated("no-op RPC")
def export_setSiteMask(self, siteList):
"""Set the site mask for matching. The mask is given in a form of Classad string.
:param list siteList: site, status
:return: S_OK()/S_ERROR()
"""
Expand All @@ -46,6 +47,7 @@ def export_setSiteMask(self, siteList):
@deprecated("no-op RPC")
def export_getSiteMask(cls, siteState="Active"):
"""Get the site mask
:param str siteState: site status
:return: S_OK(list)/S_ERROR()
"""
Expand All @@ -57,6 +59,7 @@ def export_getSiteMask(cls, siteState="Active"):
@deprecated("no-op RPC")
def export_getSiteMaskStatus(cls, sites=None):
"""Get the site mask of given site(s) with columns 'site' and 'status' only
:param sites: list of sites or site
:type sites: list or str
:return: S_OK()/S_ERROR() -- S_OK contain dict or str
Expand All @@ -70,6 +73,7 @@ def export_getSiteMaskStatus(cls, sites=None):
@deprecated("no-op RPC")
def export_getAllSiteMaskStatus(cls):
"""Get all the site parameters in the site mask
:return: dict
"""
return S_OK()
Expand All @@ -80,6 +84,7 @@ def export_getAllSiteMaskStatus(cls):
@deprecated("no-op RPC")
def export_banSite(self, site, comment="No comment"):
"""Ban the given site in the site mask
:param str site: site
:param str comment: comment
:return: S_OK()/S_ERROR()
Expand All @@ -92,6 +97,7 @@ def export_banSite(self, site, comment="No comment"):
@deprecated("no-op RPC")
def export_allowSite(self, site, comment="No comment"):
"""Allow the given site in the site mask
:param str site: site
:param str comment: comment
:return: S_OK()/S_ERROR()
Expand All @@ -105,6 +111,7 @@ def export_allowSite(self, site, comment="No comment"):
@deprecated("no-op RPC")
def export_clearMask(cls):
"""Clear up the entire site mask
:return: S_OK()/S_ERROR()
"""
return S_OK()
Expand All @@ -116,6 +123,7 @@ def export_clearMask(cls):
@deprecated("no-op RPC")
def export_getSiteMaskLogging(cls, sites):
"""Get the site mask logging history
:param list sites: sites
:return: S_OK(dict)/S_ERROR()
"""
Expand All @@ -128,6 +136,7 @@ def export_getSiteMaskLogging(cls, sites):
@deprecated("no-op RPC")
def export_getSiteMaskSummary(cls):
"""Get the mask status for all the configured sites
:return: S_OK(dict)/S_ERROR()
"""
return S_OK()
Expand Down

0 comments on commit 5292180

Please sign in to comment.