Skip to content

Commit c5bb32b

Browse files
committed
Update internals doc re: parents plurality.
This is no longer a slice; objects only have one parent.
1 parent 65b1200 commit c5bb32b

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README-INTERNALS.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ notmuch_database_t is wrapped by DB, notmuch_query_t is wrapped by Query
1515
and so on. Each of these wrappers is an alias for the type cStruct,
1616
which holds a pointer to the underlying C object, and also to the
1717
wrappers for any objects referenced by the underlying C object (via the
18-
"parents" field). This keeps the GC from collecting parent objects if
18+
`parent` field). This keeps the GC from collecting parent objects if
1919
the children are still in use.
2020

2121
## Creating objects
2222

23-
When creating an object, the caller should set the parents field to a
24-
slice containing pointers to the object's immediate parent objects, and
25-
set cptr to the underlying c pointer. Finally, calling setGcClose on the
26-
object will cause it to be released properly by the garbage collector.
23+
When creating an object, the caller should set the `parent` field to a
24+
pointer to the object's immediate parent object, and set cptr to the
25+
underlying c pointer. Finally, calling setGcClose on the object will
26+
cause it to be released properly by the garbage collector.
2727

2828
## Cleaning up
2929

0 commit comments

Comments
 (0)