From 892ff68c69278428690c606728119aaf6c0208cb Mon Sep 17 00:00:00 2001 From: Valentin Samir Date: Sun, 20 Jun 2021 00:21:35 +0200 Subject: [PATCH] Fix some docstring reStructuredText syntax --- cas_server/default_settings.py | 19 +++++++++++-------- cas_server/models.py | 2 +- 2 files changed, 12 insertions(+), 9 deletions(-) diff --git a/cas_server/default_settings.py b/cas_server/default_settings.py index 8cd092c..cbdb7f8 100644 --- a/cas_server/default_settings.py +++ b/cas_server/default_settings.py @@ -170,10 +170,11 @@ CAS_LDAP_PASSWORD_CHECK = "ldap" #: charset the LDAP users passwords was hash with CAS_LDAP_PASSWORD_CHARSET = "utf-8" #: 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 ``1`` the user attributes are retrieve then the user authenticate using -#: the user credentials. These attributes are then cached for the session. +#: +#: * 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 +#: the user credentials. These attributes are then cached for the session. +#: #: The default is ``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. #: ``CAS_INFO_MESSAGES`` is a :class:`dict` mapping message name to a message :class:`dict`. #: A message :class:`dict` has 3 keys: -#: * ``message``: A :class:`unicode`, the message to display, potentially wrapped around -#: ugettex_lazy -#: * ``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. +#: +#: * ``message``: A :class:`unicode`, the message to display, potentially wrapped around +#: ugettex_lazy +#: * ``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. +#: #: ``CAS_INFO_MESSAGES`` contains by default one message, ``cas_explained``, which explain #: roughly the purpose of a CAS. CAS_INFO_MESSAGES = { diff --git a/cas_server/models.py b/cas_server/models.py index 1b38383..51456b7 100644 --- a/cas_server/models.py +++ b/cas_server/models.py @@ -228,7 +228,7 @@ class FederateSLO(models.Model): """ class Meta: unique_together = ("username", "session_key", "ticket") - #: the federated username with the ``@``component + #: the federated username with the ``@`` component username = models.CharField(max_length=30) #: 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)