Skip to content
Snippets Groups Projects
Unverified Commit 6e4f71c0 authored by Richard van der Hoff's avatar Richard van der Hoff Committed by GitHub
Browse files

Fix a buglet in the SAML username mapping provider doc (#8873)

the constructor is called with a `module_api`.
parent cf3b8156
No related branches found
No related tags found
No related merge requests found
Fix an error in the documentation for the SAML username mapping provider.
...@@ -116,11 +116,13 @@ comment these options out and use those specified by the module instead. ...@@ -116,11 +116,13 @@ comment these options out and use those specified by the module instead.
A custom mapping provider must specify the following methods: A custom mapping provider must specify the following methods:
* `__init__(self, parsed_config)` * `__init__(self, parsed_config, module_api)`
- Arguments: - Arguments:
- `parsed_config` - A configuration object that is the return value of the - `parsed_config` - A configuration object that is the return value of the
`parse_config` method. You should set any configuration options needed by `parse_config` method. You should set any configuration options needed by
the module here. the module here.
- `module_api` - a `synapse.module_api.ModuleApi` object which provides the
stable API available for extension modules.
* `parse_config(config)` * `parse_config(config)`
- This method should have the `@staticmethod` decoration. - This method should have the `@staticmethod` decoration.
- Arguments: - Arguments:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment