Commit 7d2cb00
committed
doc: reorganize docs of module customization hooks
This reorganizes the documentation of module customization hooks
to promote the synchronous variant as it has fewer caveats.
Previously the documentation was organized as follows:
To do something:
1. For asynchronous hooks, do this, which may have these caveats
2. For synchronous hooks, do this, which does not have the caveats
To do something else:
1. For asynchronous hooks, do this, which may have these caveats
2. For synchronous hooks, do this, which does not have the caveats
It's now organized as follows:
Synchronous hooks:
To do something, do this.
To do something else, do this.
(No mention that it doesn't have caveats, because users are not supposed
to burden themselves with caveats in the other API that they do not
use).
Asynchronous hooks:
They have these caveats, if they are too complex to deal with, consider
use the synchronous variant.
To do something, do this, which may have these caveats.
To do something, do this, which may have these caveats.1 parent 85852a3 commit 7d2cb00
2 files changed
+500
-336
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1175 | 1175 | | |
1176 | 1176 | | |
1177 | 1177 | | |
1178 | | - | |
| 1178 | + | |
1179 | 1179 | | |
1180 | | - | |
| 1180 | + | |
1181 | 1181 | | |
1182 | 1182 | | |
1183 | 1183 | | |
| |||
4123 | 4123 | | |
4124 | 4124 | | |
4125 | 4125 | | |
4126 | | - | |
4127 | | - | |
4128 | 4126 | | |
4129 | 4127 | | |
4130 | 4128 | | |
| |||
4184 | 4182 | | |
4185 | 4183 | | |
4186 | 4184 | | |
| 4185 | + | |
4187 | 4186 | | |
4188 | 4187 | | |
4189 | 4188 | | |
| |||
4197 | 4196 | | |
4198 | 4197 | | |
4199 | 4198 | | |
| 4199 | + | |
4200 | 4200 | | |
4201 | 4201 | | |
4202 | 4202 | | |
| |||
0 commit comments