Skip to content

Commit 1a20fe2

Browse files
committed
docs: formatting
1 parent 9c024df commit 1a20fe2

2 files changed

Lines changed: 14 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ Bundle of commands focused on swift and streamlined git operations.
2727

2828
- **Interactive staging** of hunks (parts of a file). Displays hunk diffs with
2929
syntax highlighting, and allows resetting or navigating to the hunk.
30-
- **Smart-commit**: Open a popup to enter a commit message with syntax highlighting,
31-
commit preview, and commit title length indicators. If there are no staged
32-
changes, stages all changes before doing so (`git add -A`). Optionally trigger
33-
a `git push` afterward.
30+
- **Smart-commit**: Open a popup to enter a commit message with syntax
31+
highlighting, commit preview, and commit title length indicators. If there are
32+
no staged changes, stages all changes before doing so (`git add -A`).
33+
Optionally trigger a `git push` afterward.
3434
- Convenient commands for **amending, stashing, fixup, or undoing commits**.
3535
- Search **issues & PRs**. Open the selected issue or PR in the browser.
3636
- Open the **GitHub URL** of the current file, repo, or selected lines. Also
@@ -193,7 +193,7 @@ require("tinygit").setup {
193193
blame = {
194194
ignoreAuthors = {}, -- hide component if from these authors (useful for bots)
195195
hideAuthorNames = {}, -- show component, but hide names (useful for your own name)
196-
showOnlyTimeIfAuthor = {}, -- show only time if author is in this list
196+
showOnlyTimeIfAuthor = {}, -- show only time if these authors (useful for automated commits)
197197
maxMsgLen = 40,
198198
icon = "",
199199
},
@@ -222,7 +222,7 @@ trigger visual-mode specific changes.
222222
- Interactive straging requires `telescope`.
223223
- This command stages hunks, that is, *parts* of a file instead of the full
224224
file. It is roughly comparable to `git add -p`.
225-
- Use `<Space>` to (un)stage the hunk, `<CR>` to go to the hunk, or `<C-r>` to
225+
- Use `<Space>` to stage/unstage the hunk, `<CR>` to go to the hunk, or `<C-r>` to
226226
reset the hunk (mappings customizable). Your regular `telescope` mappings also
227227
apply.
228228
- The size of the hunks is determined by the setting `staging.contextSize`.
@@ -345,7 +345,8 @@ require("tinygit").openIssueUnderCursor()
345345
Creates a permalink to the current file/lines at GitHub. The link is opened in
346346
the browser and copied to the system clipboard. In normal mode, uses the current
347347
file, in visual mode, uses the selected lines. (Note that visual mode detection
348-
requires you to use the Lua function below instead of the `:Tinygit` ex-command.)
348+
requires you to use the Lua function below instead of the `:Tinygit`
349+
ex-command.)
349350
- `"file"`: link to the file (normal mode) or the selected lines (visual mode)
350351
- `"blame"`: link to the blame view of the file
351352
- `"repo"`: link to the repo root
@@ -357,7 +358,8 @@ require("tinygit").githubUrl("file")
357358

358359
### Push & PRs
359360
- `push` can be combined with other actions, depending on the options.
360-
- `createGitHubPr` opens a PR from the current branch browser. (This requires the
361+
- `createGitHubPr` opens a PR from the current branch browser. (This requires
362+
the
361363
repo to be a fork with sufficient information on the remote.)
362364

363365
```lua
@@ -375,7 +377,7 @@ Search the git history of the current file. Select from the matching commits to
375377
open a popup with a diff view of the changes.
376378

377379
If the config `history.autoUnshallowIfNeeded` is set to `true`, will also
378-
automatically un-shallow the repo if needed.
380+
automatically unshallow the repo if needed.
379381

380382
```lua
381383
require("tinygit").fileHistory()
@@ -428,7 +430,8 @@ require("tinygit.statusline").blame()
428430
> win bar. If your status line is too crowded, you can add the blame-component
429431
> to one of those bars instead.
430432
431-
The component can be configured with the `statusline.blame` options in the [plugin
433+
The component can be configured with the `statusline.blame` options in the
434+
[plugin
432435
configuration](#configuration).
433436

434437
### Branch state

lua/tinygit/config.lua

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ local defaultConfig = {
106106
blame = {
107107
ignoreAuthors = {}, -- hide component if from these authors (useful for bots)
108108
hideAuthorNames = {}, -- show component, but hide names (useful for your own name)
109-
showOnlyTimeIfAuthor = {}, -- show only time if author is in this list
109+
showOnlyTimeIfAuthor = {}, -- show only time if these authors (useful for automated commits)
110110
maxMsgLen = 40,
111111
icon = "",
112112
},

0 commit comments

Comments
 (0)