commit 379067d0386083b3f9531062d9f3a83a24bff745
parent f94f75dc0512def7fbfdfe100eea2dab3352d61f
Author: Gregory Anders <greg@gpanders.com>
Date: Sun, 10 Apr 2022 19:15:16 -0600
docs: update dev-api to include "create"
Diffstat:
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt
@@ -243,12 +243,13 @@ If the function acts on an object then {thing} is the name of that object
with a {thing} that groups functions under a common concept).
Use existing common {action} names if possible:
- add Append to, or insert into, a collection
- del Delete a thing (or group of things)
- exec Execute code
- get Get a thing (or group of things by query)
- list Get all things
- set Set a thing (or group of things)
+ add Append to, or insert into, a collection
+ create Create a new thing
+ del Delete a thing (or group of things)
+ exec Execute code
+ get Get a thing (or group of things by query)
+ list Get all things
+ set Set a thing (or group of things)
Use consistent names for {thing} in all API functions. E.g. a buffer is called
"buf" everywhere, not "buffer" in some places and "buf" in others.
