Skip to content

Commit

Permalink
chore(build): auto-generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Dec 9, 2024
1 parent 0319869 commit 1d3a1a6
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ The default value is 200 which will open the menu instantly in most cases so the
isn't much need for a lower value.
Values of up to about 1000 should also not cause performance issue.

# Ui Configuration
# UI Configuration
This is used to configure the whole UI of care.
# `care.config.ui`

Expand Down Expand Up @@ -272,7 +272,7 @@ sections which are represented by tables and can have a different alignment
each. This is specified with another field which takes a table with the
alignment of each section.
For example you want to have the label of an entry in a red highlight and an
icon in a entry-kind specific color left aligned first and then the source of
icon in an entry-kind specific color left aligned first and then the source of
the entry right aligned in blue. You could do that like this:
```lua
format_entry = function(entry)
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/context.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ The complete line on which the cursor was when the context was created.
`context.line_before_cursor string`

The line before the cursor. This is mostly important to be correct in insert
mode. In normal mode the character on which the cursor is is not included.
mode. In normal mode the character on which the cursor is not included.

A cursor position
# `care.context.cursor`
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/core.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,4 +85,4 @@ the last time. This is used to determine when to reopen the completion window.
`core.completing boolean`

Boolean to indicate if care is currently completing. This is used to avoid
compmleting and sorting on the same keystroke.
completing and sorting on the same keystroke.
2 changes: 1 addition & 1 deletion docs/dev/source.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Type description of care.source

# Source

The sources are used to get get completions for care.nvim.
The sources are used to get completions for care.nvim.
# `care.source`

# Methods
Expand Down
6 changes: 3 additions & 3 deletions docs/preset_utils.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ This module contains lower level utilities for the presets and the preset compon
## Label Entries
`preset_utils.label_entries(labels: string[]): fun(_,data: care.format_data): string`

This function can be used to get a function to label the entries with shortscuts as [described
This function can be used to get a function to label the entries with shortcuts as [described
here](/configuration_recipes#labels-and-shortcuts).

## Get Color
Expand All @@ -29,7 +29,7 @@ completion item.

This function allows to get a highlight group for a certain hex color code. This is useful because like that the
user doesn't have to constantly create new highlight groups to apply a hex value to a certain thing. The
highlight group will have the hex value as foregroung color.
highlight group will have the hex value as foreground color.

## Kind Highlight
`preset_utils.kind_highlight(entry: care.entry, style: "fg"|"blended"): string`
Expand All @@ -44,5 +44,5 @@ or blended.

See [care.entry](/dev/entry)

Gets the label detail if provided by the language serve.
Gets the label detail if provided by the language server.
This is equivalent to the `vim_item.menu` from nvim-cmp

0 comments on commit 1d3a1a6

Please sign in to comment.