fix: change name and remove from readme

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

README.md

@@ -286,9 +286,6 @@ minimum-version = "0.11"  # current version
 # The CMake build directory. Defaults to a unique temporary directory.
 build-dir = ""
 
-# Immediately fail the build. This is only useful in overrides.
-fail = ""
-
 ```
 
 <!-- [[[end]]] -->

src/scikit_build_core/settings/documentation.py

@@ -56,6 +56,7 @@ class DCDoc:
     docs: str
     field: dataclasses.Field[typing.Any]
     deprecated: bool = False
+    override_only: bool = False
 
 
 def sanitize_default_field(text: str) -> str:
@@ -134,4 +135,5 @@ def mk_docs(dc: type[object], prefix: str = "") -> Generator[DCDoc, None, None]:
             docs=docs[field.name],
             field=field,
             deprecated=field.metadata.get("deprecated", False),
+            override_only=field.metadata.get("override_only", False),
         )

src/scikit_build_core/settings/skbuild_docs_readme.py

@@ -46,7 +46,11 @@ def mk_skbuild_docs() -> str:
     Makes documentation for the skbuild model.
     """
     doc = Document(
-        [Item(item) for item in mk_docs(ScikitBuildSettings) if not item.deprecated]
+        [
+            Item(item)
+            for item in mk_docs(ScikitBuildSettings)
+            if not item.deprecated and not item.override_only
+        ]
     )
     return doc.format()
 

src/scikit_build_core/settings/skbuild_model.py

@@ -33,8 +33,8 @@ def __dir__() -> List[str]:
 class SettingsFieldMetadata(TypedDict, total=False):
     display_default: Optional[str]
     deprecated: bool
-    disallow_hard_code: bool
-    """Do not allow the field to be hard-coded in the pyproject table."""
+    override_only: bool
+    """Do not allow the field to be a top-level  table."""
 
 
 class CMakeSettingsDefine(str):
@@ -510,7 +510,7 @@ class ScikitBuildSettings:
     fail: Optional[bool] = dataclasses.field(
         default=None,
         metadata=SettingsFieldMetadata(
-            disallow_hard_code=True,
+            override_only=True,
         ),
     )
     """

src/scikit_build_core/settings/skbuild_overrides.py

@@ -40,16 +40,20 @@ class OverrideRecord:
 
     key: str
     """Settings key that is overridden."""
+
     original_value: Any | None
     """
     Original value in the pyproject table.
 
     If the pyproject table did not have the key, this is a ``None``.
     """
+
     value: Any
     """Final value."""
+
     passed_all: dict[str, str] | None
     """All if statements that passed (except the effective ``match_any``)."""
+
     passed_any: dict[str, str] | None
     """All if.any statements that passed."""
 

src/scikit_build_core/settings/skbuild_read_settings.py

@@ -150,7 +150,7 @@ def validate_field(
         """Do the actual validation."""
         # Check if we had a hard-coded value in the record
         conf_key = field.name.replace("_", "-")
-        if field.metadata.get("disallow_hard_code", False):
+        if field.metadata.get("override_only", False):
             original_value = record.original_value if record else value
             if original_value is not None:
                 msg = f"{prefix}{conf_key} is not allowed to be hard-coded in the pyproject.toml file"

tests/test_settings_docs.py

@@ -18,7 +18,7 @@ def test_skbuild_docs_readme() -> None:
         "A table of defines to pass to CMake when configuring the project. Additive."
         in docs
     )
-    assert "fail = false" in docs
+    assert "fail = " not in docs
     # Deprecated items are not included here
     assert "ninja.minimum-version" not in docs