From 96eaddedd7f09fcbcc390aedd7078aeecfa4c885 Mon Sep 17 00:00:00 2001
From: kali <kali@leap.se>
Date: Fri, 3 May 2013 02:59:22 +0900
Subject: updated documentation

* documentation reviewed after rewrite, ready for 0.2.1
* updated docstrings format to fit sphinx autodoc
---
 src/leap/config/providerconfig.py | 27 +++++++++++++++------------
 1 file changed, 15 insertions(+), 12 deletions(-)

(limited to 'src/leap/config/providerconfig.py')

diff --git a/src/leap/config/providerconfig.py b/src/leap/config/providerconfig.py
index 5aa0cc6e..8f75d4fe 100644
--- a/src/leap/config/providerconfig.py
+++ b/src/leap/config/providerconfig.py
@@ -68,7 +68,7 @@ class ProviderConfig(BaseConfig):
         """
         Returns the enrollment policy
 
-        @rtype: string
+        :rtype: string
         """
         return self._safe_get_value("enrollment_policy")
 
@@ -82,27 +82,28 @@ class ProviderConfig(BaseConfig):
     def get_services(self):
         """
         Returns a list with the services supported by the
-        current provider
+        current provider.
 
-        @rtype: list
+        :rtype: list
         """
         return self._safe_get_value("services")
 
     def get_services_string(self):
         """
-        Returns a string with the services supported by the current provider,
-        ready to be shown to the user
+        Returns a string with the services supported by the current
+        provider, ready to be shown to the user.
         """
         return ", ".join(self.get_services())
 
     def get_ca_cert_path(self, about_to_download=False):
         """
-        Returns the path to the certificate for the current provider
+        Returns the path to the certificate for the current provider.
 
-        @param about_to_download: defines wether we want the path to
-        download the cert or not. This helps avoid checking if the
-        cert exists because we are about to write it.
-        @type about_to_download: bool
+        :param about_to_download: defines wether we want the path to
+                                  download the cert or not. This helps avoid
+                                  checking if the cert exists because we
+                                  are about to write it.
+        :type about_to_download: bool
         """
 
         cert_path = os.path.join(self.get_path_prefix(),
@@ -122,8 +123,10 @@ class ProviderConfig(BaseConfig):
 
     def provides_eip(self):
         """
-        Returns True if this particular provider has the EIP
-        service. False otherwise
+        Returns True if this particular provider has the EIP service,
+        False otherwise.
+
+        :rtype: bool
         """
         return "openvpn" in self.get_services()
 
-- 
cgit v1.2.3