Skip to content

Commit d4e7d05

Browse files
committed
Adds ? example for printing magic usage
? is the more natural way.
1 parent 2c76db0 commit d4e7d05

File tree

2 files changed

+39
-54
lines changed

2 files changed

+39
-54
lines changed

docs/how-tos/use-in-jupyter-notebook.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -23,13 +23,17 @@ Then to use it:
2323
```python
2424
%%cell_to_module -m MODULE_NAME # more args
2525
```
26-
Other arguments (--help to print this.):
26+
To see help on the magic, you can run `%%cell_to_module --help`, or just `?%%cell_to_module` in a cell.
27+
28+
It should output information similar to the following:
29+
2730
-m, --module_name: Module name to provide. Default is jupyter_module.
2831
-c, --config: JSON config string, or variable name containing config to use.
2932
-r, --rebuild-drivers: Flag to rebuild drivers.
3033
-d, --display: Flag to visualize dataflow.
3134
-v, --verbosity: of standard output. 0 to hide. 1 is normal, default.
3235

36+
3337
Example use:
3438

3539
```python

examples/jupyter_notebook_magic/example.ipynb

+34-53
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,7 @@
3434
"end_time": "2024-02-13T06:29:15.104283Z",
3535
"start_time": "2024-02-13T06:29:15.098328Z"
3636
},
37-
"collapsed": false,
38-
"jupyter": {
39-
"outputs_hidden": false
40-
}
37+
"collapsed": false
4138
},
4239
"outputs": [],
4340
"source": [
@@ -48,18 +45,23 @@
4845
},
4946
{
5047
"cell_type": "code",
51-
"execution_count": 3,
48+
"execution_count": 7,
5249
"id": "f84593b0496cadd1",
5350
"metadata": {
54-
"ExecuteTime": {
55-
"end_time": "2024-02-13T06:29:16.402651Z",
56-
"start_time": "2024-02-13T06:29:16.396860Z"
57-
},
5851
"collapsed": false,
59-
"jupyter": {
60-
"outputs_hidden": false
52+
"ExecuteTime": {
53+
"end_time": "2024-02-13T18:14:06.109282Z",
54+
"start_time": "2024-02-13T18:14:06.087426Z"
6155
}
6256
},
57+
"outputs": [],
58+
"source": [
59+
"?%%cell_to_module \n",
60+
"# one way to show usage notes"
61+
]
62+
},
63+
{
64+
"cell_type": "code",
6365
"outputs": [
6466
{
6567
"name": "stdout",
@@ -75,9 +77,18 @@
7577
}
7678
],
7779
"source": [
78-
"%%cell_to_module --help\n",
80+
"%%cell_to_module --help \n",
7981
"# shows --help message"
80-
]
82+
],
83+
"metadata": {
84+
"collapsed": false,
85+
"ExecuteTime": {
86+
"end_time": "2024-02-13T18:14:07.660691Z",
87+
"start_time": "2024-02-13T18:14:07.644540Z"
88+
}
89+
},
90+
"id": "a7907aac424f56f4",
91+
"execution_count": 8
8192
},
8293
{
8394
"cell_type": "code",
@@ -88,10 +99,7 @@
8899
"end_time": "2024-02-13T06:29:19.482875Z",
89100
"start_time": "2024-02-13T06:29:17.737719Z"
90101
},
91-
"collapsed": false,
92-
"jupyter": {
93-
"outputs_hidden": false
94-
}
102+
"collapsed": false
95103
},
96104
"outputs": [
97105
{
@@ -240,10 +248,7 @@
240248
"end_time": "2024-02-13T06:29:19.517474Z",
241249
"start_time": "2024-02-13T06:29:19.502194Z"
242250
},
243-
"collapsed": false,
244-
"jupyter": {
245-
"outputs_hidden": false
246-
}
251+
"collapsed": false
247252
},
248253
"outputs": [],
249254
"source": [
@@ -265,10 +270,7 @@
265270
"end_time": "2024-02-13T06:29:20.866327Z",
266271
"start_time": "2024-02-13T06:29:19.569013Z"
267272
},
268-
"collapsed": false,
269-
"jupyter": {
270-
"outputs_hidden": false
271-
}
273+
"collapsed": false
272274
},
273275
"outputs": [
274276
{
@@ -293,10 +295,7 @@
293295
"end_time": "2024-02-13T06:29:20.897770Z",
294296
"start_time": "2024-02-13T06:29:20.886666Z"
295297
},
296-
"collapsed": false,
297-
"jupyter": {
298-
"outputs_hidden": false
299-
}
298+
"collapsed": false
300299
},
301300
"outputs": [],
302301
"source": [
@@ -317,10 +316,7 @@
317316
"end_time": "2024-02-13T06:29:22.187332Z",
318317
"start_time": "2024-02-13T06:29:21.011468Z"
319318
},
320-
"collapsed": false,
321-
"jupyter": {
322-
"outputs_hidden": false
323-
}
319+
"collapsed": false
324320
},
325321
"outputs": [
326322
{
@@ -353,10 +349,7 @@
353349
"end_time": "2024-02-13T06:29:22.195026Z",
354350
"start_time": "2024-02-13T06:29:22.187770Z"
355351
},
356-
"collapsed": false,
357-
"jupyter": {
358-
"outputs_hidden": false
359-
}
352+
"collapsed": false
360353
},
361354
"outputs": [],
362355
"source": [
@@ -373,10 +366,7 @@
373366
"end_time": "2024-02-13T06:29:22.701173Z",
374367
"start_time": "2024-02-13T06:29:22.399709Z"
375368
},
376-
"collapsed": false,
377-
"jupyter": {
378-
"outputs_hidden": false
379-
}
369+
"collapsed": false
380370
},
381371
"outputs": [
382372
{
@@ -478,10 +468,7 @@
478468
"end_time": "2024-02-13T06:29:23.617271Z",
479469
"start_time": "2024-02-13T06:29:23.339236Z"
480470
},
481-
"collapsed": false,
482-
"jupyter": {
483-
"outputs_hidden": false
484-
}
471+
"collapsed": false
485472
},
486473
"outputs": [
487474
{
@@ -643,10 +630,7 @@
643630
"end_time": "2024-02-13T06:29:24.456838Z",
644631
"start_time": "2024-02-13T06:29:24.447092Z"
645632
},
646-
"collapsed": false,
647-
"jupyter": {
648-
"outputs_hidden": false
649-
}
633+
"collapsed": false
650634
},
651635
"outputs": [
652636
{
@@ -669,10 +653,7 @@
669653
"execution_count": null,
670654
"id": "f8ef467eeab94c4d",
671655
"metadata": {
672-
"collapsed": false,
673-
"jupyter": {
674-
"outputs_hidden": false
675-
}
656+
"collapsed": false
676657
},
677658
"outputs": [],
678659
"source": []

0 commit comments

Comments
 (0)