Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: document max_file_length fully #597

Merged
merged 5 commits into from
Jul 25, 2022
Merged

doc: document max_file_length fully #597

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1bdd97f
doc: Document max_file_length fully
Jul 25, 2022
0c43884
doc: Fix teal original
Jul 25, 2022
8c4f51d
doc: Simplify description
andrewferrier Jul 25, 2022
bf3d581
doc: Simplify description 2
Jul 25, 2022
a6c1625
fix: Generated lua doc
Jul 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 gitsigns if file is longer than this (in lines)
andrewferrier marked this conversation as resolved.
Show resolved Hide resolved
preview_config = {
-- Options passed to nvim_open_win
border = 'single',
Expand Down
4 changes: 2 additions & 2 deletions doc/gitsigns.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 gitsigns if file is longer than this (in lines)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, sorry to make a meal of a simple change :)

preview_config = {
-- Options passed to nvim_open_win
border = 'single',
Expand Down Expand Up @@ -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]`
Expand Down
2 changes: 1 addition & 1 deletion teal/gitsigns/config.tl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
]]
},

Expand Down