Skip to content

Commit

Permalink
docs: reorder definitions
Browse files Browse the repository at this point in the history
  • Loading branch information
eero-lehtinen authored Feb 9, 2025
1 parent 3d0d5e4 commit 1dffc89
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,22 +165,21 @@ The command `:ColorPickOklch` can be used instead of `pick_under_cursor()`.
#### Definitions

```lua
---@class picker.PickUnderCursorOpts
---@field force_format? string auto detect by default
---@field fallback_open? picker.OpenPickerOpts open the picker anyway if no color under the cursor is found

--- @param opts? picker.PickUnderCursorOpts
--- @return boolean success true if a color was found and picker opened
function pick_under_cursor(opts)

---@class picker.OpenPickerOpts
---@field initial_color? string any color that the picker can parse, e.g. "#fff" (uses a random hex color by default)
---@field force_format? string auto detect by default

--- @param opts? picker.OpenPickerOpts
--- @return boolean success true if the picker was able to open
function open_picker(opts)

---@class picker.PickUnderCursorOpts
---@field force_format? string auto detect by default
---@field fallback_open? picker.OpenPickerOpts open the picker anyway if no color under the cursor is found

---@class picker.OpenPickerOpts
---@field initial_color? string any color that the picker can parse, e.g. "#fff" (uses a random hex color by default)
---@field force_format? string auto detect by default
```

### Highlighting
Expand Down

0 comments on commit 1dffc89

Please sign in to comment.