Skip to content

Commit b68ebd1

Browse files
orhuncseickel
authored andcommitted
docs: fix typos in documentation and license
1 parent 583390d commit b68ebd1

File tree

3 files changed

+26
-26
lines changed

3 files changed

+26
-26
lines changed

LICENSE

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
MIT License
22

33
Copyright (c) 2021 cseickel (https://github.com/cseickel) and nvim-neo-tree
4-
maintaners.
4+
maintainers.
55

66
Permission is hereby granted, free of charge, to any person obtaining a copy
77
of this software and associated documentation files (the "Software"), to deal

README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -401,14 +401,14 @@ What to show. Can be one of:
401401
#### `position`
402402
Where to show it, can be one of:
403403

404-
| Option | Description |
405-
|--------|-------------|
406-
| left | Open as left hand sidebar. DEFAULT |
407-
| right | Open as right hand sidebar. |
408-
| top | Open as top window. |
409-
| botom | Open as bottom window. |
410-
| float | Open as floating window. |
411-
| current | Open within the current window, like netrw or vinegar would. |
404+
| Option | Description |
405+
|---------|-------------|
406+
| left | Open as left hand sidebar. DEFAULT |
407+
| right | Open as right hand sidebar. |
408+
| top | Open as top window. |
409+
| bottom | Open as bottom window. |
410+
| float | Open as floating window. |
411+
| current | Open within the current window, like netrw or vinegar would. |
412412

413413
#### `toggle`
414414
This is a boolean flag. Adding this means that the window will be closed if it

doc/neo-tree.txt

+17-17
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ What to show. Can be one of:
7777

7878
filesystem : Show a file browser. DEFAULT
7979
buffers : Show a list of currently open buffers.
80-
git_status : Show the ouput of `git status` in a tree layout.
80+
git_status : Show the output of `git status` in a tree layout.
8181

8282
position~
8383
Where to show it, can be one of:
@@ -128,7 +128,7 @@ automatically change the directory without prompting. This option implies
128128
DEPRECATED_COMMANDS
129129

130130
The following commands from Neotree v1.x will remain until v3.0 for backwards
131-
compatability. You should not use them if you are a new user, and existing users
131+
compatibility. You should not use them if you are a new user, and existing users
132132
should change their mapping to the new |:Neotree| command specified above.
133133

134134
:NeoTreeFocus -> :Neotree
@@ -461,10 +461,10 @@ CUSTOM MAPPINGS WITH VISUAL MODE
461461

462462
If you want to create a mapping that supports visual mode, the way to do that
463463
is to add a second command where the name is the same as the normal mode
464-
command, but with `_visual` added to the end. Any mapping for this commnd will
464+
command, but with `_visual` added to the end. Any mapping for this command will
465465
then work in either normal or visual mode.
466466

467-
The `_visual` version of the command will be called with a second arguement
467+
The `_visual` version of the command will be called with a second argument
468468
which is a list of the nodes that were selected when the command was called.
469469

470470
For example, this is how the built-in `delete` command is defined:
@@ -489,7 +489,7 @@ CUSTOM MAPPINGS WITH ARGUMENTS
489489

490490
If you want to include options for your mappings, such as `nowait`, you can
491491
set this for all mappings using the `mapping_options` key, or on individual
492-
mappings by specifiying them as a table that consists of the command and any
492+
mappings by specifying them as a table that consists of the command and any
493493
options you want to use. If both are specified, the mapping merges with and
494494
overrides the global `mapping_options`
495495

@@ -821,7 +821,7 @@ The `hide_by_name` option is a list of file/folder names that should be
821821
hidden. This is an exact match.
822822

823823
The `hide_by_pattern` option uses glob syntax, which is converted to lua
824-
patterns. No gaurantees on how it handles advanced patterns.
824+
patterns. No guarantees on how it handles advanced patterns.
825825

826826
The `always_show` option is a list of file/folder names that will always be
827827
visible, even if other settings would normally hide it. This section takes
@@ -1128,7 +1128,7 @@ NeoTreeDimText Greyed out text used in various places.
11281128
NeoTreeDirectoryIcon Directory icon.
11291129
NeoTreeDirectoryName Directory name.
11301130
NeoTreeDotfile Used for icons and names when dotfiles are filtered.
1131-
NeoTreeFileIcon File icon, when not overriden by devicons.
1131+
NeoTreeFileIcon File icon, when not overridden by devicons.
11321132
NeoTreeFileName File name, when not overwritten by another status.
11331133
NeoTreeFileNameOpened File name when the file is open. Not used yet.
11341134
NeoTreeFilterTerm The filter term, as displayed in the root node.
@@ -1244,7 +1244,7 @@ Fired after leaving a neo-tree popup buffer.
12441244
Fired before opening a new Neo-tree window. Called with the following arg:
12451245
*neo-tree-window-event-args*
12461246
The event argument for all window events is a table with the following keys:
1247-
`winid` = the |winid| of the window being opned or closed.
1247+
`winid` = the |winid| of the window being opened or closed.
12481248
`tabnr` = the tab number that the window is in.
12491249
`source` = the name of the source that is in the window, such as "filesystem".
12501250
`position` = the position of the window, i.e. "left", "bottom", "right".
@@ -1304,15 +1304,15 @@ You can also define your own with:
13041304
The setup function is run the first time the event is subscribed to. For an
13051305
autocmd event, this would define the vim autocmd to connect it to fire_event().
13061306

1307-
The `seed` function is run at the begining of every event firing. The diagnostics
1307+
The `seed` function is run at the beginning of every event firing. The diagnostics
13081308
event uses this to collect the diagnostic information and pass it to all
13091309
subscribers.
13101310

13111311
The `teardown` function is used when the last subscriber unsubscribes, and cleans
13121312
up. This is like Dispose in other languages.
13131313

13141314
`debounce_frequency` is the minimum number of milliseconds between each invocation
1315-
of the event. The first event is gauranteed to fire, as well as the last one, but
1315+
of the event. The first event is guaranteed to fire, as well as the last one, but
13161316
in between events may be dropped if this is set to a number greater than zero.
13171317

13181318
`once` means to only fire this event handler once then mark it as `cancelled`.
@@ -1325,7 +1325,7 @@ COMPONENTS AND RENDERERS *neo-tree-renderers*
13251325

13261326
A renderer is just a list of component configs, to be rendered in order to
13271327
create a line in the tree. Each renderer is for a specific node type, such as
1328-
`directory` or `file`. To view the avilable built-in components and their
1328+
`directory` or `file`. To view the available built-in components and their
13291329
configs for each source, look at the default config by pasting it with
13301330
>
13311331
:lua require("neo-tree").paste_default_config()
@@ -1335,7 +1335,7 @@ https://github.com/nvim-neo-tree/neo-tree.nvim/blob/v1.x/lua/neo-tree/defaults.l
13351335

13361336
A default `renderers` config is specified at the root level and will be used
13371337
by each source unless another renderer is defined. If you just want to
1338-
reaarange or remove components, you can do so by changing these `renderers`
1338+
rearrange or remove components, you can do so by changing these `renderers`
13391339
configs.
13401340

13411341
*neo-tree-components*
@@ -1359,7 +1359,7 @@ A component is a function that returns a single text object:
13591359
highlight = "Comment"
13601360
},
13611361
{
1362-
text = "I'm Sepcial!",
1362+
text = "I'm Special!",
13631363
highlight = "SpecialChar"
13641364
},
13651365
text = "[",
@@ -1392,7 +1392,7 @@ The `"fit_content"` value means that it will be the width of the largest
13921392
layer. See `zindex` for details about layers.
13931393

13941394
If the current position is "current", meaning it is being displayed in a split
1395-
instead of as a sidebar, the avilable width will be calculated as the longest
1395+
instead of as a sidebar, the available width will be calculated as the longest
13961396
node name + indent + 8 characters. This is to prevent right aligned components
13971397
from being too far away from the node name.
13981398

@@ -1406,7 +1406,7 @@ This is a list of components that will be arranged by this container.
14061406
Each component in the content list can use these additional properties:
14071407

14081408
zindex~
1409-
All components with the same zindex will be renderered together in the same
1409+
All components with the same zindex will be rendered together in the same
14101410
layer, one after the other. Higher zindex value are rendered on top of other
14111411
layers, hiding whatever is beneath them. For example, if a component with a
14121412
zindex of 10 produces this:
@@ -1423,7 +1423,7 @@ Each component in the content list can use these additional properties:
14231423
<
14241424

14251425
align~
1426-
If align is right, then it will be pushed to the rigth edge of the avilable
1426+
If align is right, then it will be pushed to the right edge of the available
14271427
space. This makes the most sense when the container width is set to a number
14281428
or `"100%"`. Components that are right aligned will automatically overlap left
14291429
aligned components with the same zindex if there is not enough space.
@@ -1473,7 +1473,7 @@ Each component function is called with the following args:
14731473
can be made to be configurable. This is useful if you want different behavior
14741474
in a directory renderer vs a file renderer. The config is a combination of any
14751475
options specified in the default_component_configs
1476-
(|neo-tree-default-component-configs|), which can be overriden by settings
1476+
(|neo-tree-default-component-configs|), which can be overridden by settings
14771477
specified within each renderer config.
14781478

14791479
`node` The NuiNode object for this node. The properties can vary by source, but

0 commit comments

Comments
 (0)