Promote an arbitrary string to be a docstring
In https://review.openstack.org/#/c/229857/ , Lance pointed out that the string here was not being caught by pep257, and that turned out to be because it wasn't actually a docstring at all. This appears to have been intended as a module-level docstring, but because it's not the first element in the module, it's actually just a regular string, and thus not validated against PEP257. However, rather than promoting this to be a module-level docstring, the actual content refers to the Saml2 class itself (going so far as to note the class inheritance and class path for configuration), and thus it makes sense to make it a class-level docstring. Change-Id: Ie6250613291c07d4c1a41104453a590fc3a65382
This commit is contained in:
committed by
Brant Knudson
parent
99b4948439
commit
0c3e69924c
@@ -12,15 +12,17 @@
|
||||
|
||||
from keystone.auth.plugins import mapped
|
||||
|
||||
""" Provide an entry point to authenticate with SAML2
|
||||
|
||||
This plugin subclasses mapped.Mapped, and may be specified in keystone.conf:
|
||||
|
||||
[auth]
|
||||
methods = external,password,token,saml2
|
||||
saml2 = keystone.auth.plugins.mapped.Mapped
|
||||
"""
|
||||
|
||||
|
||||
class Saml2(mapped.Mapped):
|
||||
"""Provide an entry point to authenticate with SAML2.
|
||||
|
||||
This plugin subclasses ``mapped.Mapped``, and may be specified in
|
||||
keystone.conf::
|
||||
|
||||
[auth]
|
||||
methods = external,password,token,saml2
|
||||
saml2 = keystone.auth.plugins.mapped.Mapped
|
||||
|
||||
"""
|
||||
|
||||
pass
|
||||
|
||||
Reference in New Issue
Block a user