Skip to content

Commit bce3d75

Browse files
committed
Add docstring to CMakeSettingsDefine
1 parent b0261b3 commit bce3d75

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/scikit_build_core/settings/skbuild_model.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ def __dir__() -> List[str]:
2828

2929

3030
class CMakeSettingsDefine(str):
31+
"""
32+
A str subtype for automatically normalizing bool and list values
33+
to the CMake representation in the `cmake.define` settings key.
34+
"""
35+
3136
json_schema = Union[str, bool, List[str]]
3237

3338
def __new__(cls, raw: Union[str, bool, List[str]]) -> "CMakeSettingsDefine":

0 commit comments

Comments
 (0)