Skip to content

Commit 718a25c

Browse files
authored
Merge pull request #1567 from vim-jp/hh-update-sign
Update sign.{txt,jax}
2 parents 2ceb9c8 + 8c773f4 commit 718a25c

File tree

2 files changed

+56
-10
lines changed

2 files changed

+56
-10
lines changed

doc/sign.jax

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*sign.txt* For Vim バージョン 9.1. Last change: 2023 Feb 21
1+
*sign.txt* For Vim バージョン 9.1. Last change: 2024 Jun 08
22

33

44
VIMリファレンスマニュアル by Gordon Prieur
@@ -439,6 +439,9 @@ sign_define({list})
439439
<
440440
|method| としても使用できる: >
441441
GetSignList()->sign_define()
442+
<
443+
戻り値の型: |Number|
444+
442445

443446
sign_getdefined([{name}]) *sign_getdefined()*
444447
定義済みの目印とその属性のリストを取得する。
@@ -474,6 +477,9 @@ sign_getdefined([{name}]) *sign_getdefined()*
474477
<
475478
|method| としても使用できる: >
476479
GetSignList()->sign_getdefined()
480+
<
481+
戻り値の型: list<dict<string>> または list<any>
482+
477483

478484
sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
479485
バッファまたはすべてのバッファに設置されている目印のリストを返
@@ -539,8 +545,10 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
539545
|method| としても使用できる: >
540546
GetBufname()->sign_getplaced()
541547
<
542-
*sign_jump()*
543-
sign_jump({id}, {group}, {buf})
548+
戻り値の型: list<dict<any>>
549+
550+
551+
sign_jump({id}, {group}, {buf}) *sign_jump()*
544552
バッファ{buf}を開くか、{buf}を含むウィンドウに移動して、グルー
545553
{group}の目印{id}にカーソルを置く。これは |:sign-jump| コマ
546554
ンドに似ている。
@@ -557,6 +565,9 @@ sign_jump({id}, {group}, {buf})
557565
|method| としても使用できる: >
558566
GetSignid()->sign_jump()
559567
<
568+
戻り値の型: |Number|
569+
570+
560571
*sign_place()*
561572
sign_place({id}, {group}, {name}, {buf} [, {dict}])
562573
{name}として定義された目印をファイルまたはバッファ{buf}の行
@@ -610,8 +621,10 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}])
610621
|method| としても使用できる: >
611622
GetSignid()->sign_place(group, name, expr)
612623
<
613-
*sign_placelist()*
614-
sign_placelist({list})
624+
戻り値の型: |Number|
625+
626+
627+
sign_placelist({list}) *sign_placelist()*
615628
1つ以上の目印を設置する。これは |sign_place()| 関数に似ている。
616629
引数{list}には、設置する目印のリストを指定する。各リスト項目
617630
は、次の目印属性を持つ辞書である:
@@ -668,6 +681,9 @@ sign_placelist({list})
668681
<
669682
|method| としても使用できる: >
670683
GetSignlist()->sign_placelist()
684+
<
685+
戻り値の型: |Number|
686+
671687

672688
sign_undefine([{name}]) *sign_undefine()*
673689
sign_undefine({list})
@@ -693,6 +709,9 @@ sign_undefine({list})
693709
<
694710
|method| としても使用できる: >
695711
GetSignlist()->sign_undefine()
712+
<
713+
戻り値の型: |Number|
714+
696715

697716
sign_unplace({group} [, {dict}]) *sign_unplace()*
698717
設置済みの1つ以上のバッファ内の目印を解除する。これは
@@ -741,6 +760,9 @@ sign_unplace({group} [, {dict}]) *sign_unplace()*
741760
< |method| としても使用できる: >
742761
GetSigngroup()->sign_unplace()
743762
<
763+
戻り値の型: |Number|
764+
765+
744766
sign_unplacelist({list}) *sign_unplacelist()*
745767
1つ以上のバッファから以前に設置された目印を削除する。これは
746768
|sign_unplace()| 関数に似ている。
@@ -771,5 +793,6 @@ sign_unplacelist({list}) *sign_unplacelist()*
771793
|method| としても使用できる: >
772794
GetSignlist()->sign_unplacelist()
773795
<
796+
戻り値の型: list<number> または list<any>
774797

775798
vim:tw=78:ts=8:noet:ft=help:norl:

en/sign.txt

Lines changed: 28 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*sign.txt* For Vim version 9.1. Last change: 2023 Feb 21
1+
*sign.txt* For Vim version 9.1. Last change: 2024 Jun 08
22

33

44
VIM REFERENCE MANUAL by Gordon Prieur
@@ -435,6 +435,9 @@ sign_define({list})
435435
<
436436
Can also be used as a |method|: >
437437
GetSignList()->sign_define()
438+
<
439+
Return type: |Number|
440+
438441

439442
sign_getdefined([{name}]) *sign_getdefined()*
440443
Get a list of defined signs and their attributes.
@@ -473,6 +476,9 @@ sign_getdefined([{name}]) *sign_getdefined()*
473476
<
474477
Can also be used as a |method|: >
475478
GetSignList()->sign_getdefined()
479+
<
480+
Return type: list<dict<string>> or list<any>
481+
476482

477483
sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
478484
Return a list of signs placed in a buffer or all the buffers.
@@ -537,8 +543,10 @@ sign_getplaced([{buf} [, {dict}]]) *sign_getplaced()*
537543
Can also be used as a |method|: >
538544
GetBufname()->sign_getplaced()
539545
<
540-
*sign_jump()*
541-
sign_jump({id}, {group}, {buf})
546+
Return type: list<dict<any>>
547+
548+
549+
sign_jump({id}, {group}, {buf}) *sign_jump()*
542550
Open the buffer {buf} or jump to the window that contains
543551
{buf} and position the cursor at sign {id} in group {group}.
544552
This is similar to the |:sign-jump| command.
@@ -556,6 +564,9 @@ sign_jump({id}, {group}, {buf})
556564
Can also be used as a |method|: >
557565
GetSignid()->sign_jump()
558566
<
567+
Return type: |Number|
568+
569+
559570
*sign_place()*
560571
sign_place({id}, {group}, {name}, {buf} [, {dict}])
561572
Place the sign defined as {name} at line {lnum} in file or
@@ -608,8 +619,10 @@ sign_place({id}, {group}, {name}, {buf} [, {dict}])
608619
Can also be used as a |method|: >
609620
GetSignid()->sign_place(group, name, expr)
610621
<
611-
*sign_placelist()*
612-
sign_placelist({list})
622+
Return type: |Number|
623+
624+
625+
sign_placelist({list}) *sign_placelist()*
613626
Place one or more signs. This is similar to the
614627
|sign_place()| function. The {list} argument specifies the
615628
List of signs to place. Each list item is a dict with the
@@ -669,6 +682,9 @@ sign_placelist({list})
669682
<
670683
Can also be used as a |method|: >
671684
GetSignlist()->sign_placelist()
685+
<
686+
Return type: |Number|
687+
672688

673689
sign_undefine([{name}]) *sign_undefine()*
674690
sign_undefine({list})
@@ -695,6 +711,9 @@ sign_undefine({list})
695711
<
696712
Can also be used as a |method|: >
697713
GetSignlist()->sign_undefine()
714+
<
715+
Return type: |Number|
716+
698717

699718
sign_unplace({group} [, {dict}]) *sign_unplace()*
700719
Remove a previously placed sign in one or more buffers. This
@@ -741,6 +760,9 @@ sign_unplace({group} [, {dict}]) *sign_unplace()*
741760
< Can also be used as a |method|: >
742761
GetSigngroup()->sign_unplace()
743762
<
763+
Return type: |Number|
764+
765+
744766
sign_unplacelist({list}) *sign_unplacelist()*
745767
Remove previously placed signs from one or more buffers. This
746768
is similar to the |sign_unplace()| function.
@@ -772,5 +794,6 @@ sign_unplacelist({list}) *sign_unplacelist()*
772794
Can also be used as a |method|: >
773795
GetSignlist()->sign_unplacelist()
774796
<
797+
Return type: list<number> or list<any>
775798

776799
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)