Skip to content

Commit

Permalink
docs: update README and vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
bekaboo committed Jan 14, 2024
1 parent b8ec296 commit 457ab86
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 20 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,8 @@ This can have several reasons:
to show the colored column in normal mode.

2. Please make sure you have set `colorcolumn` to a value greater than 0 in
your config.
your config. Also, make sure that you have `termguicolors` set using
`:set termguicolors`

3. If you set `colorcolumn` to a relative value (e.g. `'-10'`), make sure
`textwidth` is set to a value greater than 0.
Expand Down
20 changes: 1 addition & 19 deletions doc/deadcolumn.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -213,21 +213,6 @@ deadcolumn.setup({*opts}) *deadcolumn.options.setup()*
==============================================================================
FAQ *deadcolumn.faq*

------------------------------------------------------------------------------
Why `:echo &cc` or `lua =vim.wo.cc` is empty?
*deadcolumn.faq.cc-is-empty*

If you are using the default config, this is expected.

The default config makes 'colorcolumn' visible only in insert mode and replace
mode, so it clears 'cc' in normal mode and reset it to the original value when
you enter insert mode or replace mode. As long as the 'colorcolumn' is
displayed correctly in insert mode and replace mode, you don't need to worry
about this.

If you want to see 'colorcolumn' in normal mode, you can change the option
|deadcolumn.options.ops.modes|.

------------------------------------------------------------------------------
Why can’t I see the colored column?
*deadcolumn.faq.colorcolumn-not-visible*
Expand All @@ -240,10 +225,7 @@ This can have several reasons:
|deadcolumn.options.ops.modes| to show the colored column in normal mode.

2. Please make sure you have set 'colorcolumn' to a value greater than 0 in
your config. Notice that the output of `:echo &cc` or `lua =vim.wo.cc` may
be empty even if you have set 'colorcolumn' to a value greater than 0. This
is because this plugin clears 'colorcolumn' when it is not needed to
conceal the colored column, see point 1.
your config. Also, make sure that you have 'termguicolors' set.

3. If you set 'colorcolumn' to a relative value (e.g. "-10"), make sure
'textwidth' is set to a value greater than 0.
Expand Down

0 comments on commit 457ab86

Please sign in to comment.