updating documentation in library.py

This commit is contained in:
2020-01-13 00:37:55 +00:00
parent 1f2072e837
commit b7357e1624

View File

@@ -58,22 +58,19 @@ def set_config(
Example:
`config.toml` has the following attribute set:
```
`config.toml` has the following attribute set::
[package.users]
auth = ['user1', 'user2']
```
If set as an environment variable you can pass this list as a string
and set check=list:
and set check=list::
Environment variable:
PACKAGE_USERS_AUTH = "['user1', 'user2']"
Usage in code:
```python
Usage in code::
set_config(CONFIG, 'users.auth', check=list)
```
"""
config_var = key.lower().replace('.', '_')
if check is None: