Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit12150de

Browse files
Fix broken see-also reference for inspect_request message (#18234)
* Fix broken see-also reference for inspect_request message* Update packages/services/src/kernel/messages.tsCo-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>* Update packages/services/src/kernel/messages.tsCo-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>* Update packages/services/src/kernel/messages.tsCo-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>* Fix broken inspect message See Also references* Fix broken See Also references in kernel message docs* Use TypeDoc@see {@link ...} links instead of deprecated See also syntax* Fix copy-paste typo* Fix copy-paste typo---------Co-authored-by: Michał Krassowski <5832902+krassowski@users.noreply.github.com>
1 parent092e7ee commit12150de

File tree

1 file changed

+45
-43
lines changed

1 file changed

+45
-43
lines changed

‎packages/services/src/kernel/messages.ts‎

Lines changed: 45 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ export type Channel = 'shell' | 'control' | 'iopub' | 'stdin';
267267
*
268268
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#general-message-format).
269269
*
270-
***See also:** [[IMessage]]
270+
*@see {@linkIMessage}
271271
*/
272272
exportinterfaceIHeader<TextendsMessageType=MessageType>{
273273
/**
@@ -838,8 +838,8 @@ export interface IInfoReplyMsg extends IShellMessage<'kernel_info_reply'> {
838838
* A `'complete_request'` message.
839839
*
840840
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#completion).
841-
*
842-
***See also:** [[ICompleteReplyMsg]], [[IKernel.complete]]
841+
*@see {@link ICompleteReplyMsg}
842+
*@see {@link IKernelConnection.complete}
843843
*/
844844
exportinterfaceICompleteRequestMsgextendsIShellMessage<'complete_request'>{
845845
content:{
@@ -852,8 +852,8 @@ export interface ICompleteRequestMsg extends IShellMessage<'complete_request'> {
852852
* A `'complete_reply'` message content.
853853
*
854854
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#completion).
855-
*
856-
***See also:** [[ICompleteRequest]], [[IKernel.complete]]
855+
*@see {@link ICompleteRequest}
856+
*@see {@link IKernelConnection.complete}
857857
*/
858858
interfaceICompleteReplyextendsIReplyOkContent{
859859
matches:string[];
@@ -866,8 +866,8 @@ interface ICompleteReply extends IReplyOkContent {
866866
* A `'complete_reply'` message on the `'shell'` channel.
867867
*
868868
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#completion).
869-
*
870-
***See also:** [[ICompleteRequest]], [[IKernel.complete]]
869+
*@see {@link ICompleteRequest}
870+
*@see {@link IKernelConnection.complete}
871871
*/
872872
exportinterfaceICompleteReplyMsgextendsIShellMessage<'complete_reply'>{
873873
parent_header:IHeader<'complete_request'>;
@@ -878,8 +878,8 @@ export interface ICompleteReplyMsg extends IShellMessage<'complete_reply'> {
878878
* An `'inspect_request'` message.
879879
*
880880
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#introspection).
881-
*
882-
***See also:** [[IInspectReplyMsg]], [[[IKernel.inspect]]]
881+
*@see {@link IInspectReplyMsg}
882+
*@see {@link IKernelConnection.inspect}
883883
*/
884884
exportinterfaceIInspectRequestMsgextendsIShellMessage<'inspect_request'>{
885885
content:{
@@ -893,8 +893,8 @@ export interface IInspectRequestMsg extends IShellMessage<'inspect_request'> {
893893
* A `'inspect_reply'` message content.
894894
*
895895
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#introspection).
896-
*
897-
***See also:** [[IInspectRequest]], [[IKernel.inspect]]
896+
*@see {@link IInspectRequest}
897+
*@see {@link IKernelConnection.inspect}
898898
*/
899899

900900
exportinterfaceIInspectReplyextendsIReplyOkContent{
@@ -907,9 +907,10 @@ export interface IInspectReply extends IReplyOkContent {
907907
* A `'inspect_reply'` message on the `'shell'` channel.
908908
*
909909
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#introspection).
910-
*
911-
***See also:** [[IInspectRequest]], [[IKernel.inspect]]
910+
*@see {@link IInspectRequest}
911+
*@see {@link IKernelConnection.inspect}
912912
*/
913+
913914
exportinterfaceIInspectReplyMsgextendsIShellMessage<'inspect_reply'>{
914915
parent_header:IHeader<'inspect_request'>;
915916
content:ReplyContent<IInspectReply>;
@@ -922,9 +923,10 @@ export interface IInspectReplyMsg extends IShellMessage<'inspect_reply'> {
922923
* By default JupyterLab interrupts kernels via jupyter-server Kernels REST API instead.
923924
*
924925
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#kernel-interrupt).
925-
*
926-
***See also:** [[IInterruptReplyMsg]], [[[IKernel.interrupt]]]
926+
*@see {@link IInterruptReplyMsg}
927+
*@see {@link IKernelConnection.interrupt}
927928
*/
929+
928930
exportinterfaceIInterruptRequestMsg
929931
extendsIControlMessage<'interrupt_request'>{
930932
content:Record<string,never>;
@@ -934,8 +936,8 @@ export interface IInterruptRequestMsg
934936
* A `'interrupt_reply'` message content.
935937
*
936938
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#kernel-interrupt).
937-
*
938-
***See also:** [[IInterruptRequestMsg]], [[IKernel.interrupt]]
939+
*@see {@link IInterruptRequestMsg}
940+
*@see {@link IKernelConnection.interrupt}
939941
*/
940942

941943
exportinterfaceIInterruptReplyextendsIReplyOkContent{}
@@ -944,8 +946,8 @@ export interface IInterruptReply extends IReplyOkContent {}
944946
* A `'interrupt_reply'` message on the `'control'` channel.
945947
*
946948
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#kernel-interrupt).
947-
*
948-
***See also:** [[IInterruptRequestMsg]], [[IKernel.interrupt]]
949+
*@see {@link IInterruptRequestMsg}
950+
*@see {@link IKernelConnection.interrupt}
949951
*/
950952
exportinterfaceIInterruptReplyMsgextendsIControlMessage<'interrupt_reply'>{
951953
parent_header:IHeader<'interrupt_request'>;
@@ -956,8 +958,8 @@ export interface IInterruptReplyMsg extends IControlMessage<'interrupt_reply'> {
956958
* A `'history_request'` message.
957959
*
958960
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#history).
959-
*
960-
***See also:** [[IHistoryReplyMsg]], [[[IKernel.history]]]
961+
*@see {@link IHistoryReplyMsg}
962+
*@see {@link IKernelConnection.history}
961963
*/
962964
exportinterfaceIHistoryRequestMsgextendsIShellMessage<'history_request'>{
963965
content:IHistoryRequestRange|IHistoryRequestSearch|IHistoryRequestTail;
@@ -967,8 +969,8 @@ export interface IHistoryRequestMsg extends IShellMessage<'history_request'> {
967969
* The content of a `'history_request'` range message.
968970
*
969971
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#history).
970-
*
971-
***See also:** [[IHistoryReply]], [[[IKernel.history]]]
972+
*@see {@link IHistoryReply}
973+
*@see {@link IKernelConnection.history}
972974
*/
973975
exportinterfaceIHistoryRequestRange{
974976
output:boolean;
@@ -983,8 +985,8 @@ export interface IHistoryRequestRange {
983985
* The content of a `'history_request'` search message.
984986
*
985987
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#history).
986-
*
987-
***See also:** [[IHistoryReply]], [[[IKernel.history]]]
988+
*@see {@link IHistoryReply}
989+
*@see {@link IKernelConnection.history}
988990
*/
989991
exportinterfaceIHistoryRequestSearch{
990992
output:boolean;
@@ -999,8 +1001,8 @@ export interface IHistoryRequestSearch {
9991001
* The content of a `'history_request'` tail message.
10001002
*
10011003
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#history).
1002-
*
1003-
***See also:** [[IHistoryReply]], [[[IKernel.history]]]
1004+
*@see {@link IHistoryReply}
1005+
*@see {@link IKernelConnection.history}
10041006
*/
10051007
exportinterfaceIHistoryRequestTail{
10061008
output:boolean;
@@ -1013,8 +1015,8 @@ export interface IHistoryRequestTail {
10131015
* A `'history_reply'` message content.
10141016
*
10151017
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#history).
1016-
*
1017-
***See also:** [[IHistoryRequest]], [[IKernel.history]]
1018+
*@see {@link IHistoryRequest}
1019+
*@see {@link IKernelConnection.history}
10181020
*/
10191021
exportinterfaceIHistoryReplyextendsIReplyOkContent{
10201022
history:[number,number,string][]|[number,number,[string,string]][];
@@ -1024,8 +1026,8 @@ export interface IHistoryReply extends IReplyOkContent {
10241026
* A `'history_reply'` message on the `'shell'` channel.
10251027
*
10261028
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#history).
1027-
*
1028-
***See also:** [[IHistoryRequest]], [[IKernel.history]]
1029+
*@see {@link IHistoryRequest}
1030+
*@see {@link IKernelConnection.history}
10291031
*/
10301032
exportinterfaceIHistoryReplyMsgextendsIShellMessage<'history_reply'>{
10311033
parent_header:IHeader<'history_request'>;
@@ -1036,8 +1038,8 @@ export interface IHistoryReplyMsg extends IShellMessage<'history_reply'> {
10361038
* An `'is_complete_request'` message.
10371039
*
10381040
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#code-completeness).
1039-
*
1040-
***See also:** [[IIsCompleteReplyMsg]], [[IKernel.isComplete]]
1041+
*@see {@link IIsCompleteReplyMsg}
1042+
*@see {@link IKernelConnection.isComplete}
10411043
*/
10421044
exportinterfaceIIsCompleteRequestMsg
10431045
extendsIShellMessage<'is_complete_request'>{
@@ -1050,8 +1052,8 @@ export interface IIsCompleteRequestMsg
10501052
* An `'is_complete_reply'` message on the `'stream'` channel.
10511053
*
10521054
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#code-completeness).
1053-
*
1054-
***See also:** [[IIsCompleteRequest]], [[IKernel.isComplete]]
1055+
*@see {@link IIsCompleteRequest}
1056+
*@see {@link IKernelConnection.isComplete}
10551057
*/
10561058
exportinterfaceIIsCompleteReplyMsg
10571059
extendsIShellMessage<'is_complete_reply'>{
@@ -1155,8 +1157,8 @@ export interface IExecuteReply extends IExecuteReplyBase {
11551157
* An `'execute_reply'` message on the `'stream'` channel.
11561158
*
11571159
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#execution-results).
1158-
*
1159-
***See also:** [[IExecuteRequest]], [[IKernel.execute]]
1160+
*@see {@link IExecuteRequest}
1161+
*@see {@link IKernelConnection.execute}
11601162
*/
11611163
exportinterfaceIExecuteReplyMsgextendsIShellMessage<'execute_reply'>{
11621164
parent_header:IHeader<'execute_request'>;
@@ -1174,8 +1176,8 @@ export function isExecuteReplyMsg(msg: IMessage): msg is IExecuteReplyMsg {
11741176
* A `'comm_info_request'` message on the `'shell'` channel.
11751177
*
11761178
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#comm-info).
1177-
*
1178-
***See also:** [[ICommInfoReplyMsg]], [[IKernel.commInfo]]
1179+
*@see {@link ICommInfoReplyMsg}
1180+
*@see {@link IKernelConnection.commInfo}
11791181
*/
11801182
exportinterfaceICommInfoRequestMsg
11811183
extendsIShellMessage<'comm_info_request'>{
@@ -1191,8 +1193,8 @@ export interface ICommInfoRequestMsg
11911193
* A `'comm_info_reply'` message content.
11921194
*
11931195
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#comm-info).
1194-
*
1195-
***See also:** [[ICommInfoRequest]], [[IKernel.commInfo]]
1196+
*@see {@link ICommInfoRequest}
1197+
*@see {@link IKernelConnection.commInfo}
11961198
*/
11971199
exportinterfaceICommInfoReplyextendsIReplyOkContent{
11981200
/**
@@ -1205,8 +1207,8 @@ export interface ICommInfoReply extends IReplyOkContent {
12051207
* A `'comm_info_reply'` message on the `'shell'` channel.
12061208
*
12071209
* See [Messaging in Jupyter](https://jupyter-client.readthedocs.io/en/latest/messaging.html#comm-info).
1208-
*
1209-
***See also:** [[ICommInfoRequestMsg]], [[IKernel.commInfo]]
1210+
*@see {@link ICommInfoRequestMsg}
1211+
*@see {@link IKernelConnection.commInfo}
12101212
*/
12111213
exportinterfaceICommInfoReplyMsgextendsIShellMessage<'comm_info_reply'>{
12121214
parent_header:IHeader<'comm_info_request'>;

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp