From 6a2364cbfe50441d54bd683494bd862b08d1b9ee Mon Sep 17 00:00:00 2001 From: pseudometa <73286100+chrisgrieser@users.noreply.github.com> Date: Thu, 21 Sep 2023 19:10:21 +0200 Subject: [PATCH] chore: minor comments and docs phrasing --- README.md | 6 +++--- lua/rule-breaker/ignoreRuleData.lua | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6b30235..d2d8b23 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Most LSPs provide code actions for to do that – this plugin adds commands for - Requires diagnostics provided by a source that supports neovim's builtin diagnostics system (`vim.diagnostic`). nvim's builtin LSP client and [nvim-lint](https://github.com/mfussenegger/nvim-lint) are such sources. ## Supported Linters for adding ignore-comments - + - selene - shellcheck @@ -69,8 +69,8 @@ defaultConfig = { comment = "-- selene: allow(%s)", location = "prevLine", }, - -- full list of builtin-linters found in README - yourLinter = { + -- full list of builtin linters found in README + yourCustomSource = { -- %s will be replaced with rule-id -- if location is "encloseLine", needs to be a list of two strings comment = "// disabling-comment %s", diff --git a/lua/rule-breaker/ignoreRuleData.lua b/lua/rule-breaker/ignoreRuleData.lua index 6ae6e62..5df1469 100644 --- a/lua/rule-breaker/ignoreRuleData.lua +++ b/lua/rule-breaker/ignoreRuleData.lua @@ -1,7 +1,7 @@ ---@class ruleIgnoreConfig ----@field comment string|string[] with %s for the rule id +---@field comment string|string[] "%s" will be replaced with the rule id ---@field location "sameLine"|"prevLine"|"encloseLine" ----@field docs? string url to documentation elaborating how ignore comments work for the linter +---@field docs? string only needed for auto-generated docs -- INFO "encloseLine" is a list with two strings, one to be inserted before and -- one to be inserted after. (prevLine or sameLine comments are obviously