Skip to content

Commit 607381a

Browse files
committed
Refine inherence documentation
Signed-off-by: Alex Nelson <[email protected]>
1 parent ccf32f9 commit 607381a

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

case_utils/inherent_uuid.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,11 @@
9393
)
9494

9595

96-
def inherence_uuid(n_uco_thing: URIRef, *args: Any, **kwargs: Any) -> uuid.UUID:
96+
def inherence_uuid(n_thing: URIRef, *args: Any, **kwargs: Any) -> uuid.UUID:
9797
"""
98-
This function returns a UUIDv5 for any UcoThing, that can be used as a UUID Namespace in further `uuid.uuidv5` calls.
98+
This function returns a UUIDv5 for any OWL Thing, that can be used as a UUID Namespace in further `uuid.uuidv5` calls.
9999
100-
In the case that the UcoThing ends with a UUID, that UUID string will be returned wrapped in a UUID object. In all other cases, a UUID version 5 object will be returned for the node as a name under the URL namespace [#rfc4122ac]_.
100+
In the case that the Thing is a UcoThing that ends with a UUID, that UUID string will be returned wrapped in a UUID object. In all other cases, a UUID version 5 object will be returned for the Thing as a name under the URL namespace [#rfc4122ac]_.
101101
102102
References
103103
==========
@@ -123,7 +123,7 @@ def inherence_uuid(n_uco_thing: URIRef, *args: Any, **kwargs: Any) -> uuid.UUID:
123123
>>> case_homepage_uuid_namespace
124124
UUID('2c6406b7-3396-5fdd-b9bf-c6e21273e40a')
125125
"""
126-
node_iri = str(n_uco_thing)
126+
node_iri = str(n_thing)
127127
if len(node_iri) < 40 or RX_UUID.search(node_iri) is None:
128128
# <40 -> Too short to have a UUID and scheme.
129129
return uuid.uuid5(uuid.NAMESPACE_URL, node_iri)
@@ -138,7 +138,7 @@ def facet_inherence_uuid(
138138
**kwargs: Any
139139
) -> uuid.UUID:
140140
"""
141-
:param n_facet_class: This node is expected to be the `rdflib.term.URIRef` for an OWL Class that is either in UCO or extends a class in UCO, such as `case_utils.namespace.NS_UCO_OBSERVABLE.FileFacet`. The Facet class SHOULD be a 'leaf' class - that is, it should have no OWL subclasses. (This 'SHOULD' might become a more stringent requirement in the future. uco-core:Facet must not be used. There is some question on how this rule should apply for uco-observable:WifiAddressFacet and its parent class uco-observable:MACAddressFacet.)
141+
:param n_facet_class: This node is expected to be the `rdflib.term.URIRef` for an OWL Class that is either in UCO or extends a class in UCO, such as `case_utils.namespace.NS_UCO_OBSERVABLE.FileFacet`. The Facet class SHOULD be a 'leaf' class - that is, it should have no OWL subclasses. (This 'SHOULD' might become a more stringent requirement in the future. uco-core:Facet MUST not be used. There is some question on how this rule should apply for uco-observable:WifiAddressFacet and its parent class uco-observable:MACAddressFacet.)
142142
:type n_facet_class: rdflib.term.URIRef
143143
"""
144144

0 commit comments

Comments
 (0)