update doc

h5rdmtoolbox/convention/standard_attributes.py

@@ -33,7 +33,7 @@ class StandardAttribute:
     validator: Union[pydantic.BaseModel, typing_extensions._AnnotatedAlias]
         The validator for the attribute. If the validator takes a parameter, pass it as dict.
         Examples for no-parameter validator: "$pintunits", "$standard_name", "$orcid", "$url"
-        Examples for validator with parameter: {"$regex": "^[a-z0-9_]*$"}, {"$in": ["a", "b", "c"]}
+        Examples for validator with parameter: {"$regex": r"^[a-z0-9_]*$"}, {"$in": ["a", "b", "c"]}
     description: str
         The description of the attribute
     target_method: str
@@ -352,6 +352,6 @@ def validate(self, value, parent=None, attrs=None) -> bool:
         try:
             _validated_value = self.validator.model_validate({key0: value},
                                                              context={'parent': parent, 'attrs': attrs})
-        except pydantic.ValidationError as err:
+        except pydantic.ValidationError as _:
             return False
         return True

h5rdmtoolbox/wrapper/rdf.py

@@ -474,7 +474,7 @@ def object(self):
 
     @property
     def subject(self) -> Optional[str]:
-        """Return the RDF subject, which is the @ID in JSON-LD syntax"""
+        """Return the RDF subject (a URL), which is equivalent to the @ID in JSON-LD syntax"""
         if RDF_SUBJECT_ATTR_NAME not in self._attr:
             return
         return self._attr[RDF_SUBJECT_ATTR_NAME]
@@ -487,11 +487,14 @@ def subject(self):
     @subject.setter
     def subject(self, jsonld_id: Union[str, HttpUrl]):
         """Set the RDF subject, which is the @ID in JSON-LD syntax.
+        Hence a valdi URL is required. This is validated by pydantic!
 
         Raises
         ------
         TypeError
             If the subject is not a string or URL
+        RDFError
+            If the URL is invalid
         """
         if not isinstance(jsonld_id, str):
             raise TypeError(f'Expecting a string or URL. Got {type(jsonld_id)}. Note, that a subject '