diff options
| author | kali <kali@leap.se> | 2013-05-03 02:59:22 +0900 |
|---|---|---|
| committer | kali <kali@leap.se> | 2013-05-11 21:59:58 +0900 |
| commit | 2dae2703fb8c2ae7e721ce83020c0dd10ff9ca33 (patch) | |
| tree | 280cb8751c56d43769fb15ead4fb4476960ae06c /src/leap/crypto/srpregister.py | |
| parent | c85894efdbd6f65eb2b0c2edfc216827c192c1d1 (diff) | |
updated documentation
* documentation reviewed after rewrite, ready for 0.2.1
* updated docstrings format to fit sphinx autodoc
Diffstat (limited to 'src/leap/crypto/srpregister.py')
| -rw-r--r-- | src/leap/crypto/srpregister.py | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/src/leap/crypto/srpregister.py b/src/leap/crypto/srpregister.py index 749b6f8c..07b3c917 100644 --- a/src/leap/crypto/srpregister.py +++ b/src/leap/crypto/srpregister.py @@ -48,11 +48,11 @@ class SRPRegister(QtCore.QObject): """ Constructor - @param provider_config: provider configuration instance, + :param provider_config: provider configuration instance, properly loaded - @type privider_config: ProviderConfig - @param register_path: webapp path for registering users - @type register_path; str + :type privider_config: ProviderConfig + :param register_path: webapp path for registering users + :type register_path; str """ QtCore.QObject.__init__(self) leap_assert(provider_config, "Please provide a provider") @@ -84,7 +84,7 @@ class SRPRegister(QtCore.QObject): Returns the URI where the register request should be made for the provider - @rtype: str + :rtype: str """ uri = "https://%s:%s/%s/%s" % ( @@ -99,13 +99,13 @@ class SRPRegister(QtCore.QObject): """ Registers a user with the validator based on the password provider - @param username: username to register - @type username: str - @param password: password for this username - @type password: str + :param username: username to register + :type username: str + :param password: password for this username + :type password: str - @rtype: tuple - @rparam: (ok, request) + :rtype: tuple + :rparam: (ok, request) """ salt, verifier = self._srp.create_salted_verification_key( username, |