Skip to content

Commit 2bc3333

Browse files
andrewferriergithub-actions[bot]
andrewferrier
authored and
github-actions[bot]
committed
chore: Auto generate Vim docs
1 parent a96e114 commit 2bc3333

File tree

1 file changed

+40
-42
lines changed

1 file changed

+40
-42
lines changed

‎doc/debugprint.nvim.txt

+40-42
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*debugprint.nvim.txt* For NVIM Last change: 2024-12-10
1+
*debugprint.nvim.txt* For NVIM Last change: 2024-12-11
22

33
==============================================================================
44
Table of Contents *debugprint.nvim-table-of-contents*
@@ -109,51 +109,48 @@ of the box'. There are also some function invocations which are not mapped to
109109
any keymappings or commands by default, but could be. This is all shown in the
110110
following table.
111111

112-
--------------------------------------------------------------------------------------
113-
Mode Default Key / Cmd Purpose Above/Below
114-
Line
115-
------------ --------------------------- ------------------------------- -------------
116-
Normal g?p Plain debug Below
112+
-------------------------------------------------------------------------------------------------
113+
Mode Default Key / Cmd Purpose Above/Below
114+
Line
115+
------------ --------------------------- ------------------------------------------ -------------
116+
Normal g?p Plain debug Below
117117

118-
Normal g?P Plain debug Above
118+
Normal g?P Plain debug Above
119119

120-
Normal g?v Variable debug Below
120+
Normal g?v Variable debug Below
121121

122-
Normal g?V Variable debug Above
122+
Normal g?V Variable debug Above
123123

124-
Normal None Variable debug (always prompt Below
125-
for variable)
124+
Normal None Variable debug (always prompt for Below
125+
variable)
126126

127-
Normal None Variable debug (always prompt Above
128-
for variable)
127+
Normal None Variable debug (always prompt for Above
128+
variable)
129129

130-
Normal None Delete debug lines in buffer -
130+
Normal None Delete debug lines in buffer -
131131

132-
Normal None Comment/uncomment debug lines -
133-
in buffer
132+
Normal None Comment/uncomment debug lines in buffer -
134133

135-
Insert Ctrl-G p Plain debug In-place
134+
Insert Ctrl-G p Plain debug In-place
136135

137-
Insert Ctrl-G v Variable debug (always prompt In-place
138-
for variable)
136+
Insert Ctrl-G v Variable debug (always prompt for In-place
137+
variable)
139138

140-
Visual g?v Variable debug Below
139+
Visual g?v Variable debug Below
141140

142-
Visual g?V Variable debug Above
141+
Visual g?V Variable debug Above
143142

144-
Op-pending g?o Variable debug Below
143+
Op-pending g?o Variable debug Below
145144

146-
Op-pending g?O Variable debug Above
145+
Op-pending g?O Variable debug Above
147146

148-
Command :DeleteDebugPrints Delete debug lines in buffer -
147+
Command :DeleteDebugPrints Delete debug lines in buffer -
149148

150-
Command :ToggleCommentDebugPrints Comment/uncomment debug lines -
151-
in buffer
149+
Command :ToggleCommentDebugPrints Comment/uncomment debug lines in buffer -
152150

153-
Command :ResetDebugPrintsCounter Reset debug print persistent -
154-
counter (only for built-in
155-
counter implementation)
156-
--------------------------------------------------------------------------------------
151+
Command :ResetDebugPrintsCounter Reset debug print persistent counter (only -
152+
for built-in counter implementation)
153+
-------------------------------------------------------------------------------------------------
157154
The keys and commands outlined above can be specifically overridden using the
158155
`keymaps` and `commands` objects inside the `opts` object used above during
159156
configuration of debugprint. For example, if configuring via `lazy.nvim`, it
@@ -223,31 +220,32 @@ they are used to convert sections to ROT-13, which most folks don’t use.
223220

224221
`debugprint` supports the following options in its global `opts` object:
225222

226-
---------------------------------------------------------------------------------------------
223+
------------------------------------------------------------------------------------------
227224
Option Default Purpose
228-
------------------- ------------ ------------------------------------------------------------
225+
------------------- ------------ ---------------------------------------------------------
229226
move_to_debugline false When adding a debug line, moves the cursor to that line
230227

231228
display_location true Include the filename and linenumber of the line being
232229
debugged in the debug message
233230

234-
display_counter true Include the increasing integer counter in the debug message.
235-
(If you want to customize this counter, or make it
236-
non-persistent, see instructions in the showcase for an
237-
example).
231+
display_counter true Include the increasing integer counter in the debug
232+
message. (If you want to customize this counter, or make
233+
it non-persistent, see instructions in the showcase for
234+
an example).
238235

239236
display_snippet true Include a snippet of the line above/below in the debug
240237
message (plain debug lines only) for context
241238

242239
filetypes See (the Custom filetypes - see showcase
243240
code)
244241

245-
print_tag DEBUGPRINT The string inserted into each print statement, which can be
246-
used to uniquely identify statements inserted by debugprint.
247-
If you set this to '' (the empty string), no print tag will
248-
be included, but this will disable the ability to delete or
249-
comment print statements via debugprint
250-
---------------------------------------------------------------------------------------------
242+
print_tag DEBUGPRINT The string inserted into each print statement, which can
243+
be used to uniquely identify statements inserted by
244+
debugprint. If you set this to '' (the empty string), no
245+
print tag will be included, but this will disable the
246+
ability to delete or comment print statements via
247+
debugprint
248+
------------------------------------------------------------------------------------------
251249

252250
==============================================================================
253251
8. Known Limitations *debugprint.nvim-known-limitations*

0 commit comments

Comments
 (0)