diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2024-05-06 04:42:30 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-06 04:42:30 -0700 |
| commit | 783c1e596c35e44e9699e5a1881d3c8f5c4fc596 (patch) | |
| tree | fdef03ec82aa36b4d2feb96b58cbd8a45eb95f1c /runtime/doc/develop.txt | |
| parent | b024643ca7571cffb3dcc79c21dbccfe14aa3a6f (diff) | |
| download | rneovim-783c1e596c35e44e9699e5a1881d3c8f5c4fc596.tar.gz rneovim-783c1e596c35e44e9699e5a1881d3c8f5c4fc596.tar.bz2 rneovim-783c1e596c35e44e9699e5a1881d3c8f5c4fc596.zip | |
refactor(snippet): rename exit() => stop() #28628
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index f2eef7b131..7fc154441f 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -373,6 +373,9 @@ Use existing common {verb} names (actions) if possible: - add: Appends or inserts into a collection - attach: Listens to something to get events from it (TODO: rename to "on"?) - call: Calls a function + - cancel: Cancels or dismisses an event or interaction, typically + user-initiated and without error. (Compare "abort", which + cancels and signals error/failure.) - clear: Clears state but does not destroy the container - create: Creates a new (non-trivial) thing (TODO: rename to "def"?) - del: Deletes a thing (or group of things) @@ -388,10 +391,14 @@ Use existing common {verb} names (actions) if possible: - open: Opens something (a buffer, window, …) - parse: Parses something into a structured form - set: Sets a thing (or group of things) + - start: Spin up a long-lived process. Prefer "enable" except when + "start" is obviously more appropriate. + - stop: Inverse of "start". Teardown a long-lived process. - try_{verb}: Best-effort operation, failure returns null or error obj Do NOT use these deprecated verbs: - disable: Prefer `enable(enable: boolean)`. + - exit: Prefer "cancel" (or "stop" if appropriate). - is_disabled: Prefer `is_enabled()`. - list: Redundant with "get" - notify: Redundant with "print", "echo" |