Skip to content

Commit c4c44e6

Browse files
committed
add names and remove descriptions since they are redundant
1 parent 06a7ef2 commit c4c44e6

File tree

1 file changed

+17
-12
lines changed

1 file changed

+17
-12
lines changed

custom_components/pyscript/services.yaml

Lines changed: 17 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,78 @@
11
# Describes the format for available pyscript services
22

33
reload:
4-
description: Reload all available pyscripts and restart triggers
4+
name: Reload pyscript
5+
description: Reloads all available pyscripts and restart triggers
56
fields:
67
global_ctx:
8+
name: Global Context
79
description: only reload this specific global context (file or app)
810
example: file.example
911
required: false
1012
selector:
1113
text:
1214

1315
jupyter_kernel_start:
14-
description: Start a jupyter kernel for interactive use; called by Jupyter front end
16+
name: Start Jupyter kernel
17+
description: Starts a jupyter kernel for interactive use; called by Jupyter front end
1518
fields:
1619
shell_port:
17-
description: shell port number
20+
name: Shell Port Number
1821
example: 63599
1922
required: false
2023
selector:
2124
number:
2225
min: 49152
2326
max: 65535
2427
iopub_port:
25-
description: iopub port number
28+
name: IOPub Port Number
2629
example: 63598
2730
required: false
2831
selector:
2932
number:
3033
min: 49152
3134
max: 65535
3235
stdin_port:
33-
description: stdin port number
36+
name: Stdin Port Number
3437
example: 63597
3538
required: false
3639
selector:
3740
number:
3841
min: 49152
3942
max: 65535
4043
control_port:
41-
description: control port number
44+
name: Control Port Number
4245
example: 63596
4346
required: false
4447
selector:
4548
number:
4649
min: 49152
4750
max: 65535
4851
hb_port:
49-
description: heartbeat port number
52+
name: Heartbeat Port Number
5053
example: 63595
5154
required: false
5255
selector:
5356
number:
5457
min: 49152
5558
max: 65535
5659
ip:
57-
description: ip address to connect to jupyter front end
60+
name: IP Address
61+
description: IP address to connect to Jupyter front end
5862
example: 127.0.0.1
5963
default: 127.0.0.1
6064
required: false
6165
selector:
6266
text:
6367
key:
64-
description: security key for signing
68+
name: Security Key
69+
description: Used for signing
6570
example: 012345678-9abcdef023456789abcdef
6671
required: true
6772
selector:
6873
text:
6974
transport:
70-
description: type of transport
75+
name: Transport Type
7176
example: tcp
7277
default: tcp
7378
required: false
@@ -77,7 +82,7 @@ jupyter_kernel_start:
7782
- tcp
7883
- udp
7984
signature_scheme:
80-
description: signing algorithm
85+
name: Signing Algorithm
8186
example: hmac-sha256
8287
required: false
8388
default: hmac-sha256
@@ -86,7 +91,7 @@ jupyter_kernel_start:
8691
options:
8792
- hmac-sha256
8893
kernel_name:
89-
description: name of kernel
94+
name: Name of Kernel
9095
example: pyscript
9196
required: true
9297
default: pyscript

0 commit comments

Comments
 (0)