diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2016-09-24 15:07:49 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2016-09-24 15:07:49 +0200 |
| commit | e65895941ca262e1ca708b19ea18d72a77761279 (patch) | |
| tree | 4932d5a1efe09a9b55c11460c39f3c6d0c828c0a /runtime/doc/develop.txt | |
| parent | 54d41ff0495505f54f9072c58988302b8a1d69be (diff) | |
| download | rneovim-e65895941ca262e1ca708b19ea18d72a77761279.tar.gz rneovim-e65895941ca262e1ca708b19ea18d72a77761279.tar.bz2 rneovim-e65895941ca262e1ca708b19ea18d72a77761279.zip | |
doc/deprecated.txt (#5338)
`deprecated.txt` is a place for deprecated tags to live.
- Encourages aggressive documentation of deprecations without cluttering
the main help files.
- Provides a single browsable reference of all deprecations.
Other changes:
- Move tags to doc/vim_diff.txt.
- Remove doc/quotes.txt. It has little historical value, except maybe the
Larry Wall quote.
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index ddec137079..b738da9bec 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -213,13 +213,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 - get get a thing (or subset of things by some query) - set set a thing - del delete a thing (or group of things) - list get all things + add Append to, or insert into, a collection + get Get a thing (or subset of things by some query) + set Set a thing + del Delete a thing (or group of things) + list Get all things -Use consistent names for {thing} in all API function. E.g. a buffer is called +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. Example: `nvim_get_current_line` acts on the global editor state; the common |