From 7e1f3b2a040e37895cc6797e5fb6032f9165e5c9 Mon Sep 17 00:00:00 2001
From: akianonymus <anonymus.aki@gmail.com>
Date: Wed, 22 Feb 2023 18:43:01 +0530
Subject: fix: Improve individual opts behaviour | #48

See https://github.com/NvChad/nvim-colorizer.lua/issues/48

css is true, names is true: Show names
css is true, names is unset: Show names
css is true, names is false: Don't show names
---
 doc/colorizer.txt | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

(limited to 'doc/colorizer.txt')

diff --git a/doc/colorizer.txt b/doc/colorizer.txt
index 1727fc4..0dfbf63 100644
--- a/doc/colorizer.txt
+++ b/doc/colorizer.txt
@@ -192,6 +192,39 @@ clear_highlight_cache()                        *colorizer.clear_highlight_cache*
 user_default_options                            *colorizer.user_default_options*
     defaults options.
 
+    In `user_default_options`, there are 2 types of options
+
+    1. Individual options - `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`,
+       `rgb_fn` , `RRGGBBAA`, `AARRGGBB`, `tailwind`, `sass`
+
+    1. Alias options - `css`, `css_fn`
+
+    If `css_fn` is true, then `hsl_fn`, `rgb_fn` becomes `true`
+
+    If `css` is true, then `names`, `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`,
+    `rgb_fn` becomes `true`
+
+    These options have a priority, Individual options have the highest priority,
+    then alias options
+
+    For alias, `css_fn` has more priority over `css`
+
+    e.g: Here `RGB`, `RRGGBB`, `RRGGBBAA`, `hsl_fn`, `rgb_fn` is enabled but not
+    `names`
+
+>
+      require 'colorizer'.setup { user_default_options = { names = false, css =
+      true } }
+<
+
+    e.g: Here `names`, `RGB`, `RRGGBB`, `RRGGBBAA` is enabled but not `rgb_fn`
+    and `hsl_fn`
+
+>
+      require 'colorizer'.setup { user_default_options = { css_fn = false, css =
+      true } }
+<
+
 >
       user_default_options = {
 	  RGB = true, -- #RGB hex codes
-- 
cgit v1.2.3-70-g09d2