Skip to content

Commit

Permalink
docs(ALL): use updated MiniDoc.afterlines_to_code()
Browse files Browse the repository at this point in the history
  • Loading branch information
echasnovski committed Jun 23, 2024
1 parent bb9e680 commit 334a2d9
Show file tree
Hide file tree
Showing 40 changed files with 41 additions and 41 deletions.
2 changes: 1 addition & 1 deletion doc/mini-ai.txt
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniAi.config = {
-- Table with textobject id as fields, textobject specification as values.
-- Also use this to disable builtin textobjects. See |MiniAi.config|.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-align.txt
Original file line number Diff line number Diff line change
Expand Up @@ -424,7 +424,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniAlign.config = {
-- Module mappings. Use `''` (empty string) to disable one.
mappings = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-animate.txt
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniAnimate.config = {
-- Cursor path
cursor = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-base16.txt
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniBase16.config = {
-- Table with names from `base00` to `base0F` and values being strings of
-- HEX colors with format "#RRGGBB". NOTE: this should be explicitly
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-basics.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniBasics.config = {
-- Options. Set to `false` to disable.
options = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-bracketed.txt
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniBracketed.config = {
-- First-level elements are tables describing behavior of a target:
--
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-bufremove.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniBufremove.config = {
-- Whether to set Vim's settings for buffers (allow hidden buffers)
set_vim_settings = true,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-clue.txt
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniClue.config = {
-- Array of extra clues to show
clues = {},
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-colors.txt
Original file line number Diff line number Diff line change
Expand Up @@ -677,7 +677,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniColors.config = {}
<

Expand Down
2 changes: 1 addition & 1 deletion doc/mini-comment.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniComment.config = {
-- Options which control module behavior
options = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-completion.txt
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniCompletion.config = {
-- Delay (debounce type, in ms) between certain Neovim event and action.
-- This can be used to (virtually) disable certain automatic actions by
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-cursorword.txt
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniCursorword.config = {
-- Delay (in ms) between when cursor moved and when highlighting appeared
delay = 100,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-deps.txt
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniDeps.config = {
-- Parameters of CLI jobs
job = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-diff.txt
Original file line number Diff line number Diff line change
Expand Up @@ -236,7 +236,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniDiff.config = {
-- Options for how hunks are visualized
view = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -154,7 +154,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniDoc.config = {
-- Function which extracts part of line used to denote annotation.
-- For more information see 'Notes' in |MiniDoc.config|.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-extra.txt
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniExtra.config = {}
<

Expand Down
2 changes: 1 addition & 1 deletion doc/mini-files.txt
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniFiles.config = {
-- Customization of shown content
content = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-fuzzy.txt
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniFuzzy.config = {
-- Maximum allowed value of match features (width and first match). All
-- feature values greater than cutoff can be considered "equally bad".
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-git.txt
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniGit.config = {
-- General CLI execution
job = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-hipatterns.txt
Original file line number Diff line number Diff line change
Expand Up @@ -229,7 +229,7 @@ Note: no highlighters is defined by default. Add them for visible effect.
Module config

Default values:
>
>lua
MiniHipatterns.config = {
-- Table with highlighters (see |MiniHipatterns.config| for more details).
-- Nothing is defined by default. Add manually for visible effect.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-hues.txt
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ See |MiniHues.make_palette()| for more information about how certain
settings affect output color scheme.

Default values:
>
>lua
MiniHues.config = {
-- **Required** base colors as '#rrggbb' hex strings
background = nil,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-indentscope.txt
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniIndentscope.config = {
-- Draw options
draw = {
Expand Down
4 changes: 2 additions & 2 deletions doc/mini-jump.txt
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniJump.config = {
-- Module mappings. Use `''` (empty string) to disable one.
mappings = {
Expand Down Expand Up @@ -120,7 +120,7 @@ Fields ~
|MiniJump.smart_jump| and all mappings won't require target.

Initial values:
>
>lua
MiniJump.state = {
target = nil,
backward = false,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-jump2d.txt
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniJump2d.config = {
-- Function producing jump spots (byte indexed) for a particular line.
-- For more information see |MiniJump2d.start|.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-map.txt
Original file line number Diff line number Diff line change
Expand Up @@ -187,7 +187,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniMap.config = {
-- Highlight integrations (none by default)
integrations = nil,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-misc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniMisc.config = {
-- Array of fields to make global (to be used as independent variables)
make_global = { 'put', 'put_text' },
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-move.txt
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniMove.config = {
-- Module mappings. Use `''` (empty string) to disable one.
mappings = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-notify.txt
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniNotify.config = {
-- Content management
content = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-operators.txt
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniOperators.config = {
-- Each entry configures one operator.
-- `prefix` defines keys mapped during `setup()`: in Normal mode
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-pairs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniPairs.config = {
-- In which modes mappings from this `config` should be created
modes = { insert = true, command = false, terminal = false },
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-pick.txt
Original file line number Diff line number Diff line change
Expand Up @@ -675,7 +675,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniPick.config = {
-- Delays (in ms; should be at least 1)
delay = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-sessions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniSessions.config = {
-- Whether to read latest session if Neovim opened without file arguments
autoread = false,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-splitjoin.txt
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniSplitjoin.config = {
-- Module mappings. Use `''` (empty string) to disable one.
-- Created for both Normal and Visual modes.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-starter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniStarter.config = {
-- Whether to open starter buffer on VimEnter. Not opened if Neovim was
-- started with intent to show something else.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-statusline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniStatusline.config = {
-- Content of statusline as functions which return statusline string. See
-- `:h statusline` and code of default contents (used instead of `nil`).
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-surround.txt
Original file line number Diff line number Diff line change
Expand Up @@ -460,7 +460,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniSurround.config = {
-- Add custom surroundings to be used on top of builtin ones. For more
-- information with examples, see `:h MiniSurround.config`.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-tabline.txt
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniTabline.config = {
-- Whether to show file icons (requires 'nvim-tree/nvim-web-devicons')
show_icons = true,
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-test.txt
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniTest.config = {
-- Options for collection of test cases. See `:h MiniTest.collect()`.
collect = {
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-trailspace.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniTrailspace.config = {
-- Highlight only in normal buffers (ones with empty 'buftype'). This is
-- useful to not show trailing whitespace where it usually doesn't matter.
Expand Down
2 changes: 1 addition & 1 deletion doc/mini-visits.txt
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ Usage ~
Module config

Default values:
>
>lua
MiniVisits.config = {
-- How visit index is converted to list of paths
list = {
Expand Down

0 comments on commit 334a2d9

Please sign in to comment.