summaryrefslogtreecommitdiff
path: root/src/leap/common/config
diff options
context:
space:
mode:
authorKali Kaneko <kali@leap.se>2013-05-29 05:00:22 +0900
committerKali Kaneko <kali@leap.se>2013-05-29 05:05:09 +0900
commit354467c605f07042568c10c3e931f7fc093c0bf4 (patch)
tree6dd8abad51635726d3a2cb09caabbe14097de07a /src/leap/common/config
parent9c12f4cce20ea1dea7e39cda583cb29ded4b4e1a (diff)
change docstring comments to use sphinx style
Diffstat (limited to 'src/leap/common/config')
-rw-r--r--src/leap/common/config/baseconfig.py4
-rw-r--r--src/leap/common/config/prefixers.py16
2 files changed, 10 insertions, 10 deletions
diff --git a/src/leap/common/config/baseconfig.py b/src/leap/common/config/baseconfig.py
index 2beb4ce..e6bd9c4 100644
--- a/src/leap/common/config/baseconfig.py
+++ b/src/leap/common/config/baseconfig.py
@@ -67,8 +67,8 @@ class BaseConfig:
"""
Tries to return a value only if the config has already been loaded.
- @rtype: depends on the config structure, dict, str, array, int
- @return: returns the value for the specified key in the config
+ :rtype: depends on the config structure, dict, str, array, int
+ :return: returns the value for the specified key in the config
"""
leap_assert(self._config_checker, "Load the config first")
return self._config_checker.config.get(key, None)
diff --git a/src/leap/common/config/prefixers.py b/src/leap/common/config/prefixers.py
index 27274bd..050d4cd 100644
--- a/src/leap/common/config/prefixers.py
+++ b/src/leap/common/config/prefixers.py
@@ -39,10 +39,10 @@ class Prefixer:
"""
Returns the platform dependant path prefixer
- @param standalone: if True it will return the prefix for a
+ :param standalone: if True it will return the prefix for a
standalone application. Otherwise, it will return the system
default for configuration storage.
- @type standalone: bool
+ :type standalone: bool
"""
return ""
@@ -65,10 +65,10 @@ class LinuxPrefixer(Prefixer):
This method expects an env variable named LEAP_CLIENT_PATH if
standalone is used.
- @param standalone: if True it will return the prefix for a
+ :param standalone: if True it will return the prefix for a
standalone application. Otherwise, it will return the system
default for configuration storage.
- @type standalone: bool
+ :type standalone: bool
"""
config_dir = BaseDirectory.xdg_config_home
if not standalone:
@@ -87,10 +87,10 @@ class DarwinPrefixer(Prefixer):
This method expects an env variable named LEAP_CLIENT_PATH if
standalone is used.
- @param standalone: if True it will return the prefix for a
+ :param standalone: if True it will return the prefix for a
standalone application. Otherwise, it will return the system
default for configuration storage.
- @type standalone: bool
+ :type standalone: bool
"""
config_dir = BaseDirectory.xdg_config_home
if not standalone:
@@ -109,10 +109,10 @@ class WindowsPrefixer(Prefixer):
This method expects an env variable named LEAP_CLIENT_PATH if
standalone is used.
- @param standalone: if True it will return the prefix for a
+ :param standalone: if True it will return the prefix for a
standalone application. Otherwise, it will return the system
default for configuration storage.
- @type standalone: bool
+ :type standalone: bool
"""
config_dir = BaseDirectory.xdg_config_home