colin/sublime-music
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

More documentation!

Browse Source
This commit is contained in:
Sumner Evans
2020-04-18 08:47:47 -06:00
parent 44bd78db46
commit b7f5543339
2 changed files with 30 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
sublime/adapters/adapter_base.py
View File

@@ -82,7 +82,7 @@ class Adapter(abc.ABC):
"""
Specifies the settings which can be configured for the adapter.
:returns: An ordered dictionary where the keys are the name of the
:returns: An dictionary where the keys are the name of the
configuration paramter and the values are the
:class:`ConfigParamDescriptor` object corresponding to that
configuration parameter. The order of the keys in the dictionary
@@ -100,10 +100,9 @@ class Adapter(abc.ABC):
:param config: The adapter configuration. The keys of are the
configuration parameter names as defined by the return value of the
:class:`get_config_parameters` function. The values are the actual
value of the configuration parameter.
It is guaranteed that all configuration parameters that are marked
as required will have a value in ``config``.
value of the configuration parameter. It is guaranteed that all
configuration parameters that are marked as required will have a
value in ``config``.
:returns: A dictionary containing varification errors. The keys of the
returned dictionary should be the same as the passed in via the