doc: document max_file_length fully (#597)

Co-authored-by: Lewis Russell <me@lewisr.dev>
lewis6991 · Jul 25, 2022 · 8b817e7 · 8b817e7
1 parent 48ac827
commit 8b817e7
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 5 deletions.
diff --git a/README.md b/README.md
@@ -102,7 +102,7 @@ require('gitsigns').setup {
   sign_priority = 6,
   update_debounce = 100,
   status_formatter = nil, -- Use default
-  max_file_length = 40000,
+  max_file_length = 40000, -- Disable if file is longer than this (in lines)
   preview_config = {
     -- Options passed to nvim_open_win
     border = 'single',

diff --git a/doc/gitsigns.txt b/doc/gitsigns.txt
@@ -61,7 +61,7 @@ of the default settings:
       sign_priority = 6,
       update_debounce = 100,
       status_formatter = nil, -- Use default
-      max_file_length = 40000,
+      max_file_length = 40000, -- Disable if file is longer than this (in lines)
       preview_config = {
         -- Options passed to nvim_open_win
         border = 'single',
@@ -668,7 +668,7 @@ status_formatter                            *gitsigns-config-status_formatter*
 max_file_length                              *gitsigns-config-max_file_length*
       Type: `number`, Default: `40000`
 
-      Max file length to attach to.
+      Max file length (in lines) to attach to.
 
 preview_config                                *gitsigns-config-preview_config*
       Type: `table[extended]`

diff --git a/lua/gitsigns/config.lua b/lua/gitsigns/config.lua
diff --git a/teal/gitsigns/config.tl b/teal/gitsigns/config.tl
@@ -388,7 +388,7 @@ M.schema = {
     type = 'number',
     default = 40000,
     description = [[
-      Max file length to attach to.
+      Max file length (in lines) to attach to.
     ]]
   },