Skip to content

Commit fc2eb79

Browse files
committed
docs(contributing): define "used" for helper order as direct reference
Owner clarification: getattr and registry-map reach do not count as use in read() or make().
1 parent f001050 commit fc2eb79

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

‎docs/source/contributing/conventions/protocol-member-order.rst‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@ The Order
2121

2222
a. **Data.** ``_make_data()`` comes first in the group, before everything else.
2323
b. **Helpers.** The helpers that ``read()`` or ``make()`` call, one helper at a
24-
time, in the order ``read()`` or ``make()`` first uses them. Each helper's
24+
time, in the order ``read()`` or ``make()`` first uses them. "Uses" means a
25+
direct reference in the body of ``read()`` or ``make()``. Helpers reached only
26+
through ``getattr``, or through the registry maps (``__proto__``,
27+
``__option__``, ``__parameter__`` and similar), do not count. Each helper's
2528
``_read_`` and ``_make_`` methods stay together, with the reader first:
2629
``_read_mac_addr()`` then ``_make_mac_addr()``.
2730
c. **Specific readers and makers.** The option, type and parameter methods,

0 commit comments

Comments
 (0)