Skip to content

Commit

Permalink
chore(docs): typos
Browse files Browse the repository at this point in the history
  • Loading branch information
numToStr committed Feb 2, 2023
1 parent a2e7d6e commit eb8bc0c
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<h1 align='center'>Navigator.nvim</h1>
<p align="center"><sup>✨ Smoothly navigate between neovim and multiplexer ✨</sup></p>
<p align="center"><sup>✨ Smoothly navigate between neovim and multiplexer(s) ✨</sup></p>

![Navigator](https://user-images.githubusercontent.com/24727447/157040356-1f44323a-c7b6-4955-8207-5e6cade08c9e.gif "Navigating to the moon")

`Navigator.nvim` provides set of [functions](#lua-api) and [commands](#commands) that allows you to seemlessly navigate between neovim and different [terminal multiplexers](#multiplexers).
`Navigator.nvim` provides set of [functions](#lua-api) and [commands](#commands) that allows you to seamlessly navigate between neovim and different [terminal multiplexers](#multiplexers).

### 🚀 Installation

Expand Down
6 changes: 3 additions & 3 deletions lua/Navigator/init.lua
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
--- | \| (_| \/ | (_| (_| |_ (_) | o | | \/ | | | |
--- _|
---
--- · Smoothly navigate between neovim and multipexers ·
--- · Smoothly navigate between neovim and multiplexer(s) ·
---
---@brief ]]

---@toc navigator.contents

---@mod navigator-nvim Introduction
---@brief [[
---Navigator.nvim provides set of functions and commands that allows you to seemlessly
---Navigator.nvim provides set of functions and commands that allows you to seamlessly
---navigate between neovim and different terminal multiplexers. It also allows you to
---integrate your own custom multipexer.
---integrate your own custom multiplexer.
---@brief ]]

---@mod navigator.commands Commands
Expand Down
3 changes: 1 addition & 2 deletions lua/Navigator/mux/vi.lua
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ function Vi:new()
end

---Checks whether neovim is maximized
---NOTE: For neovim, this always returns `false`.
---@return boolean
---@return boolean #For neovim, it'll always returns `false`
function Vi.zoomed()
return false
end
Expand Down

0 comments on commit eb8bc0c

Please sign in to comment.