Skip to content

Commit

Permalink
doc(spelling): dropbat -> dropbar (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
Gee19 authored May 30, 2023
1 parent 03f6e86 commit 3bae147
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1026,7 +1026,7 @@ symbol in the global table `_G.dropbar.on_click_callbacks` so that nvim knows
which function to call when a symbol is clicked.
`dropbat_t` has the following fields:
`dropbar_t` has the following fields:
| Field | Type | Description |
| -------------- | --------------------------------- | --------------------------------------------------------------------------------------------- |
Expand All @@ -1048,7 +1048,7 @@ which function to call when a symbol is clicked.
| `dropbar_t:new(opts: dropbar_opts_t): dropbar_t` | constructor of `dropbar_t` |
| `dropbar_t:del()` | destructor of `dropbar_t` |
| `dropbar_t:displaywidth(): integer` | returns the display width of the dropbar |
| `dropbat_t:truncate()` | truncates the dropbar if it exceeds the display width <br> *side effect: changes dropbar components<sub>[`dropbar_symbol_t[]`](#dropbar_symbol_t) |
| `dropbar_t:truncate()` | truncates the dropbar if it exceeds the display width <br> *side effect: changes dropbar components<sub>[`dropbar_symbol_t[]`](#dropbar_symbol_t) |
| `dropbar_t:cat(plain: boolean?): string` | concatenates the dropbar components into a string with substrings for highlights and click support if `plain` is not set; else returns a plain string without substrings for highlights and click support |
| `dropbar_t:redraw()` | redraws the dropbar |
| `dropbar_t:update()` | update dropbar components<sub>[`dropbar_symbol_t[]`](#dropbar_symbol_t)</sub> and redraw the dropbar afterwards |
Expand Down
24 changes: 12 additions & 12 deletions doc/dropbar.txt
Original file line number Diff line number Diff line change
Expand Up @@ -764,65 +764,65 @@ function to call when a symbol is clicked.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

`dropbat_t` has the following fields:
`dropbar_t` has the following fields:

dropbat_t.buf *dropbar_t.buf*
dropbar_t.buf *dropbar_t.buf*

The buffer the dropbar is attached to

Type ~
integer

dropbat_t.win *dropbar_t.win*
dropbar_t.win *dropbar_t.win*

The window the dropbar is attached to

Type ~
integer

dropbat_t.sources *dropbar_t.sources*
dropbar_t.sources *dropbar_t.sources*

Sourcess that provide symbols to the dropbar

Type ~
`dropbar_source_t`[]

dropbat_t.separator *dropbar_t.separator*
dropbar_t.separator *dropbar_t.separator*

Seprarator between symbols provided by sources

Type ~
`dropbar_symbol_t`

dropbat_t.padding *dropbar_t.padding*
dropbar_t.padding *dropbar_t.padding*

Padding to use between the winbar and the window border

Type ~
{ left: integer, right: integer }

dropbat_t.extends *dropbar_t.extends*
dropbar_t.extends *dropbar_t.extends*

Symbol to use at the end of a symbol when it is truncated

Type ~
`dropbar_symbol_t`

dropbat_t.components *dropbar_t.components*
dropbar_t.components *dropbar_t.components*

Symbols got from sources

Type ~
`dropbar_symbol_t`[]

dropbat_t.string_cache *dropbar_t.string_cache*
dropbar_t.string_cache *dropbar_t.string_cache*

String cache of the dropbar

Type ~
string

dropbat_t.in_pick_mode *dropbar_t.in_pick_mode*
dropbar_t.in_pick_mode *dropbar_t.in_pick_mode*

Whether the dropbar is in pick mode

Expand Down Expand Up @@ -854,7 +854,7 @@ dropbar_t:displaywidth() *dropbar_t:displaywidth()*
Returns ~
The display width of the dropbar

dropbat_t:truncate() *dropbar_t:truncate()*
dropbar_t:truncate() *dropbar_t:truncate()*

Truncates the dropbar if it exceeds the window width

Expand Down Expand Up @@ -912,7 +912,7 @@ DROPBAR_SYMBOL_T *dropbar-developers-classes-dropbar_symbol_t*
Declared and defined in `lua/dropbar/bar.lua`.

`dropbar_symbol_t` is a class that represents a symbol in a dropbar. It is the
basic element of `dropbat_t` and `dropbar_menu_entry_t`, see
basic element of `dropbar_t` and `dropbar_menu_entry_t`, see
|dropbar-developers-classes-dropbar_t| and
|dropbar-developers-classes-dropbar_menu_entry_t| for more information.

Expand Down

0 comments on commit 3bae147

Please sign in to comment.