Skip to content

Commit e256908

Browse files
committed
node attr tweaks
1 parent 72234eb commit e256908

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

docs/nodes/NodeObject.rst

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,34 @@ NodeObject
66
:exclude-members: NODE_NAME, graph, id, model, type_, view
77

88
.. autoattribute:: NODE_NAME
9-
:annotation: = (re-implementation required)
9+
:annotation:
1010

1111
Initial base node name.
1212

13+
.. note:: re-implement this attribute to provide a base node name.
14+
1315
:return: node name
1416
:rtype: str
1517

1618
.. autoattribute:: __identifier__
17-
:annotation: = (re-implementation required)
19+
:annotation:
1820

1921
Unique node identifier domain. eg. ``"com.chantacticvfx"``
2022

23+
.. note:: re-implement this attribute to provide a unique node type.
24+
2125
:return: node identifer domain
2226
:rtype: str
2327

2428
.. autoattribute:: graph
2529
.. autoattribute:: id
2630
.. autoattribute:: model
2731
.. autoattribute:: type_
28-
:annotation: = (__identifier__.__className__)
32+
:annotation:
2933

3034
Node type identifier followed by the class name. `eg.` ``"com.chantacticvfx.NodeObject"``
3135

32-
:return: node type
36+
:return: node type (``__identifier__.__className__``)
3337
:rtype: str
3438

3539
.. autoattribute:: view

0 commit comments

Comments
 (0)