Skip to content

Commit 3bc99dd

Browse files
committed
📝 Update README to remove outdated schema example and add formatting command
1 parent b9a0724 commit 3bc99dd

File tree

1 file changed

+2
-20
lines changed

1 file changed

+2
-20
lines changed

readme.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -207,23 +207,6 @@ properly. These are:
207207
already present. It is required to have AT MINIMAL the `enabled` key set to `False` or
208208
`True` (you generally want to prefer `True` for a more intuitive experience to new
209209
users, but it is not required, especially if you code just for yourself).
210-
- `schema`: A dictionary (or a `schema.Schema`, if you want more granular control)
211-
containing the schema for the extension's configuration. This is used to validate the
212-
configuration in the `config.yml` file. The schema should be a dictionary where the
213-
keys are the configuration keys, and the values are the types of the values. For
214-
example:
215-
216-
```python
217-
schema = {
218-
"enabled": bool,
219-
"token": str,
220-
"prefix": str,
221-
"channel": int,
222-
"role": int,
223-
"users": list,
224-
"options": dict,
225-
}
226-
```
227210

228211
We really encourage you to follow these instructions, even if you’re coding privately,
229212
as it will make your code more readable and maintainable in the long run.
@@ -514,9 +497,8 @@ requests with descriptive commit messages.
514497
## Code Style and Linting
515498

516499
This project follows the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide
517-
for Python code. We recommend using a linter like [black](https://github.com/psf/black)
518-
to ensure your code adheres to the style guidelines. We provide a command to lint the
519-
code using `pdm run lint`. For this to work you have to install the development
500+
for Python code. We provide a command to lint the code using `pdm run lint` and format
501+
it with `pdm run format`. For this to work you have to install the development
520502
dependencies using `pdm install -d` if you haven't already.
521503

522504
## Copyright Headers Management

0 commit comments

Comments
 (0)