Make documentation mirror custom_linting_rules (#5056)
Some checks failed
CI / build_image (push) Has been cancelled
CI / test_ale (--linters-only) (push) Has been cancelled
CI / test_ale (--lua-only) (push) Has been cancelled
CI / test_ale (--neovim-07-only) (push) Has been cancelled
CI / test_ale (--neovim-08-only) (push) Has been cancelled
CI / test_ale (--vim-80-only) (push) Has been cancelled
CI / test_ale (--vim-90-only) (push) Has been cancelled

Co-authored-by: cos <cos>
This commit is contained in:
rymdbar
2025-10-27 13:56:35 +01:00
committed by GitHub
parent d2f4090c33
commit 6d8e4a641c

View File

@@ -85,9 +85,11 @@ The following general coding standards should be adhered to for Vim code.
* Try to keep lines no longer than 80 characters, but this isn't an absolute * Try to keep lines no longer than 80 characters, but this isn't an absolute
requirement. requirement.
* Use 4 spaces for every level of indentation in Vim code. * Use 4 spaces for every level of indentation in Vim code.
* Add a blank line before every `function`, `if`, `for`, `while`, or `return`, * Add a blank line before every `function`, `if`, `for`, `while`, `try`, or `return`,
which doesn't start a new level of indentation. This makes the logic in which doesn't start a new level of indentation. When adding more code on the
your code easier to follow. same indentation level, also add blank lines after every corresponding end
for those mentioned keywords. This makes the logic in your code easier to
follow.
* End every file with a trailing newline character, but not with extra blank * End every file with a trailing newline character, but not with extra blank
lines. Remove trailing whitespace from the ends of lines. lines. Remove trailing whitespace from the ends of lines.
* Write the full names of commands instead of abbreviations. For example, write * Write the full names of commands instead of abbreviations. For example, write