Skip to content

Commit 5f01c1a

Browse files
numToStrgithub-actions[bot]
authored andcommitted
chore(docs): auto-generate :help doc
1 parent 83bfdc8 commit 5f01c1a

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

doc/Comment.txt

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ C.setup({config?}) *comment.usage.setup*
7777
{config?} (CommentConfig) User configuration
7878

7979
Returns: ~
80-
{CommentConfig} Returns the mutated config
80+
(CommentConfig) Returns the modified config
8181

8282
See: ~
8383
|comment.config|
@@ -203,7 +203,7 @@ Config:get() *comment.config:get*
203203
Get the config
204204

205205
Returns: ~
206-
{CommentConfig}
206+
(CommentConfig)
207207

208208
Usage: ~
209209
>
@@ -463,7 +463,7 @@ api.locked({cb}) *comment.api.locked*
463463
{cb} (string) Name of API function
464464

465465
Returns: ~
466-
{fun(motion:OpMotion)} Callback function
466+
(fun(motion:OpMotion)) Callback function
467467

468468
See: ~
469469
|lockmarks|
@@ -503,7 +503,7 @@ api.call({cb}, {op}) *comment.api.call*
503503
{op} ("g@"|"g@$") Operator-mode expression
504504

505505
Returns: ~
506-
{fun():string} Keymap RHS callback
506+
(fun():string) Keymap RHS callback
507507

508508
See: ~
509509
|g@|
@@ -543,7 +543,7 @@ ft.set({lang}, {val}) *comment.ft.set*
543543
{val} (string|string[])
544544

545545
Returns: ~
546-
{table} Returns itself
546+
(table) Returns itself
547547

548548
Usage: ~
549549
>
@@ -573,7 +573,7 @@ ft.get({lang}, {ctype?}) *comment.ft.get*
573573
return a copy of { line, block } commentstring.
574574

575575
Returns: ~
576-
{nil|string|string[]} Commentstring
576+
(nil|string|string[]) Commentstring
577577

578578
Usage: ~
579579
>
@@ -606,7 +606,7 @@ ft.contains({tree}, {range}) *comment.ft.contains*
606606
{start_row, start_col, end_row, end_col}
607607

608608
Returns: ~
609-
{userdata} Returns a |treesitter-languagetree|
609+
(userdata) Returns a |treesitter-languagetree|
610610

611611
See: ~
612612
|treesitter-languagetree|
@@ -628,7 +628,7 @@ ft.calculate({ctx}) *comment.ft.calculate*
628628
{ctx} (CommentCtx)
629629

630630
Returns: ~
631-
{nil|string} Commentstring
631+
(nil|string) Commentstring
632632

633633
See: ~
634634
|comment.utils.CommentCtx|
@@ -714,7 +714,7 @@ U.get_region({opmode?}) *comment.utils.get_region*
714714
{opmode?} (OpMotion)
715715

716716
Returns: ~
717-
{CommentRange}
717+
(CommentRange)
718718

719719

720720
U.get_count_lines({count}) *comment.utils.get_count_lines*
@@ -724,8 +724,8 @@ U.get_count_lines({count}) *comment.utils.get_count_lines*
724724
{count} (integer) Probably 'vim.v.count'
725725

726726
Returns: ~
727-
{string[]} List of lines
728-
{CommentRange}
727+
(string[]) List of lines
728+
(CommentRange)
729729

730730

731731
U.get_lines({range}) *comment.utils.get_lines*
@@ -735,7 +735,7 @@ U.get_lines({range}) *comment.utils.get_lines*
735735
{range} (CommentRange)
736736

737737
Returns: ~
738-
{string[]} List of lines
738+
(string[]) List of lines
739739

740740

741741
U.unwrap_cstr({cstr}) *comment.utils.unwrap_cstr*
@@ -745,8 +745,8 @@ U.unwrap_cstr({cstr}) *comment.utils.unwrap_cstr*
745745
{cstr} (string) See 'commentstring'
746746

747747
Returns: ~
748-
{string} Left side of the commentstring
749-
{string} Right side of the commentstring
748+
(string) Left side of the commentstring
749+
(string) Right side of the commentstring
750750

751751

752752
U.parse_cstr({cfg}, {ctx}) *comment.utils.parse_cstr*
@@ -760,8 +760,8 @@ U.parse_cstr({cfg}, {ctx}) *comment.utils.parse_cstr*
760760
{ctx} (CommentCtx)
761761

762762
Returns: ~
763-
{string} Left side of the commentstring
764-
{string} Right side of the commentstring
763+
(string) Left side of the commentstring
764+
(string) Right side of the commentstring
765765

766766

767767
*comment.utils.commenter*
@@ -780,7 +780,7 @@ U.commenter({left}, {right}, {padding}, {scol?}, {ecol?}, {tabbed?})
780780
{tabbed?} (boolean) Using tab indentation
781781

782782
Returns: ~
783-
{fun(line:string|string[]):string|string[]}
783+
(fun(line:string|string[]):string|string[])
784784

785785

786786
*comment.utils.uncommenter*
@@ -798,7 +798,7 @@ U.uncommenter({left}, {right}, {padding}, {scol?}, {ecol?})
798798
{ecol?} (integer) Ending column
799799

800800
Returns: ~
801-
{fun(line:string|string[]):string|string[]}
801+
(fun(line:string|string[]):string|string[])
802802

803803

804804
*comment.utils.is_commented*
@@ -817,7 +817,7 @@ U.is_commented({left}, {right}, {padding}, {scol?}, {ecol?})
817817
{ecol?} (integer) Ending column
818818

819819
Returns: ~
820-
{fun(line:string|string[]):boolean}
820+
(fun(line:string|string[]):boolean)
821821

822822

823823
================================================================================
@@ -879,7 +879,7 @@ Op.linewise({param}) *comment.opfunc.linewise*
879879
{param} (OpFnParams)
880880

881881
Returns: ~
882-
{integer} Returns a calculated comment mode
882+
(integer) Returns a calculated comment mode
883883

884884

885885
Op.blockwise({param}, {partial?}) *comment.opfunc.blockwise*
@@ -890,7 +890,7 @@ Op.blockwise({param}, {partial?}) *comment.opfunc.blockwise*
890890
{partial?} (boolean) Comment the partial region (visual mode)
891891

892892
Returns: ~
893-
{integer} Returns a calculated comment mode
893+
(integer) Returns a calculated comment mode
894894

895895

896896
================================================================================

0 commit comments

Comments
 (0)