annotate example-notebook.ipynb @ 67:b5fd860bd157

Update README.md Remove useless VCR contributing rules committer: GitHub <noreply@github.com>
author Brendan Rius <brendan.rius@gmail.com>
date Fri, 11 Aug 2017 00:23:21 +0200
parents 6455ec6914b3
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
1 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
2 "cells": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
3 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
4 "cell_type": "markdown",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
5 "metadata": {},
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
6 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
7 "# Valid code"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
8 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
9 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
10 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
11 "cell_type": "code",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
12 "execution_count": 1,
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
13 "metadata": {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
14 "collapsed": false
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
15 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
16 "outputs": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
17 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
18 "name": "stderr",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
19 "output_type": "stream",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
20 "text": []
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
21 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
22 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
23 "name": "stdout",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
24 "output_type": "stream",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
25 "text": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
26 "Hello world\n"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
27 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
28 }
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
29 ],
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
30 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
31 "#include <stdio.h>\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
32 "\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
33 "int main() {\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
34 " printf(\"Hello world\\n\");\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
35 "}"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
36 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
37 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
38 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
39 "cell_type": "markdown",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
40 "metadata": {},
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
41 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
42 "But the kernel will also display compilations warnings and errors if we have some. Let's try to remove the `#include <stdio.h>` statement, which if necessary for `printf` to work."
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
43 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
44 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
45 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
46 "cell_type": "markdown",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
47 "metadata": {},
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
48 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
49 "# Code generating warnings during compilation"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
50 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
51 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
52 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
53 "cell_type": "code",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
54 "execution_count": 2,
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
55 "metadata": {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
56 "collapsed": false
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
57 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
58 "outputs": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
59 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
60 "name": "stderr",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
61 "output_type": "stream",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
62 "text": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
63 "/var/folders/31/qct57s856n5f0b2r4tgbmn1c0000gn/T/tmp0Qan0v.c:2:5: warning: implicitly declaring library function 'printf' with type 'int (const char *, ...)' [-Wimplicit-function-declaration]\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
64 " printf(\"Hello world\\n\");\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
65 " ^\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
66 "/var/folders/31/qct57s856n5f0b2r4tgbmn1c0000gn/T/tmp0Qan0v.c:2:5: note: include the header <stdio.h> or explicitly provide a declaration for 'printf'\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
67 "1 warning generated.\n"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
68 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
69 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
70 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
71 "name": "stdout",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
72 "output_type": "stream",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
73 "text": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
74 "Hello world\n"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
75 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
76 }
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
77 ],
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
78 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
79 "int main() {\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
80 " printf(\"Hello world\\n\");\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
81 "}"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
82 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
83 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
84 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
85 "cell_type": "markdown",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
86 "metadata": {},
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
87 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
88 "You can see that the warning are displayed, but the code is still executed."
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
89 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
90 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
91 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
92 "cell_type": "markdown",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
93 "metadata": {},
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
94 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
95 "# Code generating errors during compilation"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
96 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
97 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
98 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
99 "cell_type": "code",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
100 "execution_count": 3,
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
101 "metadata": {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
102 "collapsed": false
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
103 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
104 "outputs": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
105 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
106 "name": "stderr",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
107 "output_type": "stream",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
108 "text": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
109 "/var/folders/31/qct57s856n5f0b2r4tgbmn1c0000gn/T/tmpw4Kz3c.c:2:5: warning: implicitly declaring library function 'printf' with type 'int (const char *, ...)' [-Wimplicit-function-declaration]\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
110 " printf(\"Hello world\")\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
111 " ^\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
112 "/var/folders/31/qct57s856n5f0b2r4tgbmn1c0000gn/T/tmpw4Kz3c.c:2:5: note: include the header <stdio.h> or explicitly provide a declaration for 'printf'\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
113 "/var/folders/31/qct57s856n5f0b2r4tgbmn1c0000gn/T/tmpw4Kz3c.c:2:26: error: expected ';' after expression\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
114 " printf(\"Hello world\")\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
115 " ^\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
116 " ;\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
117 "1 warning and 1 error generated.\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
118 "[C kernel] GCC exited with code 1, the executable will not be executed"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
119 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
120 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
121 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
122 "name": "stdout",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
123 "output_type": "stream",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
124 "text": []
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
125 }
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
126 ],
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
127 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
128 "int main() {\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
129 " printf(\"Hello world\")\n",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
130 "}"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
131 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
132 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
133 {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
134 "cell_type": "markdown",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
135 "metadata": {},
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
136 "source": [
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
137 "You can see that the errors and warnings are shown, but the code is not executed. The retcode is also added to the end of `stderr`"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
138 ]
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
139 }
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
140 ],
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
141 "metadata": {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
142 "kernelspec": {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
143 "display_name": "C",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
144 "language": "c",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
145 "name": "c_kernel"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
146 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
147 "language_info": {
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
148 "file_extension": "c",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
149 "mimetype": "text/plain",
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
150 "name": "c"
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
151 }
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
152 },
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
153 "nbformat": 4,
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
154 "nbformat_minor": 0
c4f5d97f80d0 Add example notebook
Brendan Rius <brendan@omixy.com>
parents:
diff changeset
155 }