kumi/django-cas-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix some docstring reStructuredText syntax

Browse source
This commit is contained in:
Valentin Samir 2021-06-20 00:21:35 +02:00
parent 75e00f02e7
commit 892ff68c69
2 changed files with 12 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
cas_server/default_settings.py
View file

@ -170,10 +170,11 @@ CAS_LDAP_PASSWORD_CHECK = "ldap"
#: charset the LDAP users passwords was hash with #: charset the LDAP users passwords was hash with
CAS_LDAP_PASSWORD_CHARSET = "utf-8" CAS_LDAP_PASSWORD_CHARSET = "utf-8"
#: This parameter is only used then ``CAS_LDAP_PASSWORD_CHECK`` is set to ``"bind"``. #: This parameter is only used then ``CAS_LDAP_PASSWORD_CHECK`` is set to ``"bind"``.
#: * if ``0`` the user attributes are retrieved by connecting to the ldap as #:
#: ``CAS_LDAP_USER``. #: * if ``0`` the user attributes are retrieved by connecting to the ldap as ``CAS_LDAP_USER``.
#: * if ``1`` the user attributes are retrieve then the user authenticate using #: * if ``1`` the user attributes are retrieve then the user authenticate using
#: the user credentials. These attributes are then cached for the session. #: the user credentials. These attributes are then cached for the session.
#:
#: The default is ``0``. #: The default is ``0``.
CAS_LDAP_ATTRS_VIEW = 0 CAS_LDAP_ATTRS_VIEW = 0
@ -215,10 +216,12 @@ CAS_SHOW_SERVICE_MESSAGES = True
#: Messages displayed in a info-box on the html pages of the default templates. #: Messages displayed in a info-box on the html pages of the default templates.
#: ``CAS_INFO_MESSAGES`` is a :class:`dict` mapping message name to a message :class:`dict`. #: ``CAS_INFO_MESSAGES`` is a :class:`dict` mapping message name to a message :class:`dict`.
#: A message :class:`dict` has 3 keys: #: A message :class:`dict` has 3 keys:
#:
#: * ``message``: A :class:`unicode`, the message to display, potentially wrapped around #: * ``message``: A :class:`unicode`, the message to display, potentially wrapped around
#: ugettex_lazy #: ugettex_lazy
#: * ``discardable``: A :class:`bool`, specify if the users can close the message info-box #: * ``discardable``: A :class:`bool`, specify if the users can close the message info-box
#: * ``type``: One of info, success, info, warning, danger. The type of the info-box. #: * ``type``: One of info, success, info, warning, danger. The type of the info-box.
#:
#: ``CAS_INFO_MESSAGES`` contains by default one message, ``cas_explained``, which explain #: ``CAS_INFO_MESSAGES`` contains by default one message, ``cas_explained``, which explain
#: roughly the purpose of a CAS. #: roughly the purpose of a CAS.
CAS_INFO_MESSAGES = { CAS_INFO_MESSAGES = {

2
cas_server/models.py
View file

@ -228,7 +228,7 @@ class FederateSLO(models.Model):
""" """
class Meta: class Meta:
unique_together = ("username", "session_key", "ticket") unique_together = ("username", "session_key", "ticket")
#: the federated username with the ``@``component #: the federated username with the ``@`` component
username = models.CharField(max_length=30) username = models.CharField(max_length=30)
#: the session key for the session :attr:`username` has been authenticated using :attr:`ticket` #: the session key for the session :attr:`username` has been authenticated using :attr:`ticket`
session_key = models.CharField(max_length=40, blank=True, null=True) session_key = models.CharField(max_length=40, blank=True, null=True)