Swift: avoid wrongly using doc instead of desc for properties

This commit is contained in:
Paolo Tranquilli
2022-11-10 09:29:02 +01:00
parent d35e5ac752
commit a8e6dc7a54
2 changed files with 18 additions and 0 deletions

View File

@@ -16,6 +16,8 @@ class _DocModifier(_schema.PropertyModifier):
doc: str
def modify(self, prop: _schema.Property):
if "\n" in self.doc or self.doc[-1] == ".":
raise _schema.Error("No newlines or trailing dots are allowed in doc, did you intend to use desc?")
prop.doc = self.doc

View File

@@ -559,6 +559,22 @@ def test_property_doc_override():
}
def test_property_doc_override_no_newlines():
with pytest.raises(schema.Error):
@schema.load
class data:
class A:
x: int | defs.doc("no multiple\nlines")
def test_property_doc_override_no_trailing_dot():
with pytest.raises(schema.Error):
@schema.load
class data:
class A:
x: int | defs.doc("no dots please.")
def test_class_default_doc_name():
@schema.load
class data: