Skip to content

Commit 8c82930

Browse files
committed
Update unreleased file as no longer need a class Config
1 parent c76203e commit 8c82930

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

doc/changes/unreleased.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,15 +42,14 @@ With this major release, you **should modify** your project's `noxconfig.py` to
4242
from __future__ import annotations
4343

4444
from pathlib import Path
45-
from typing import Iterable
4645

4746
from exasol.toolbox.config import BaseConfig
4847

49-
50-
class Config(BaseConfig):
51-
plugins: Iterable[object] = ()
52-
5348
"""
49+
A class `Config` only needs to be defined if:
50+
- you have custom attributes to pass to your project-defined nox sessions
51+
- you need to override a convention in the PTB.
52+
5453
These values do NOT need to be defined if your project follows the convention
5554
expected from the PTB:
5655
- documentation_path
@@ -66,8 +65,11 @@ If you have additional Paths that used one of these values (i.e. `root_path`), t
6665
you can define your own property in `class Config(BaseConfig)`, which accesses the
6766
class values
6867
"""
68+
class Config(BaseConfig):
69+
custom_field: str = "custom_field"
6970

70-
PROJECT_CONFIG = Config(
71+
# For most projects, the PROJECT_CONFIG would look like:
72+
PROJECT_CONFIG = BaseConfig(
7173
project_name="{{cookiecutter.package_name}}",
7274
root_path=Path(__file__).parent,
7375
)

0 commit comments

Comments
 (0)