Merge pull request #151 from janpfeifer/comments

Include function comments in the generated code
janpfeifer · Jan 20, 2025 · 2255c95 · 2255c95
2 parents 7169983 + 44917eb
commit 2255c95
Show file tree

Hide file tree

Showing 22 changed files with 128 additions and 62 deletions.
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -6,6 +6,7 @@
 * Added `%version`, and environment variables `GONB_VERSION`, `GONB_GIT_COMMIT`.
 * Added `%help` info on missing environment variables.
 * Added stack traces to protocol parsing errors.
+* Include function comments in the generated code. This makes tags like `//go:noinline` work. See #150
 
 ## v0.10.6, 2024/10/16, Improved Docker, added `%capture`
 

diff --git a/examples/tests/bash_script.ipynb b/examples/tests/bash_script.ipynb
@@ -34,7 +34,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/tmp/gonb_b9edd581\n"
+      "/tmp/gonb_d300f5a2\n"
      ]
     }
    ],
@@ -59,7 +59,7 @@
      "output_type": "stream",
      "text": [
       "/home/janpf/Projects/gonb/examples/tests\n",
-      "/tmp/gonb_b9edd581\n",
+      "/tmp/gonb_d300f5a2\n",
       "/home/janpf/Projects/gonb\n",
       "/home/janpf/Projects/gonb\n"
      ]
@@ -86,7 +86,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/capture.ipynb b/examples/tests/capture.ipynb
@@ -177,7 +177,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/comms.ipynb b/examples/tests/comms.ipynb
@@ -308,7 +308,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/dom.ipynb b/examples/tests/dom.ipynb
@@ -88,7 +88,7 @@
     {
      "data": {
       "text/html": [
-       "<div id=\"dom.transient_div_32726297\"></div>"
+       "<div id=\"dom.transient_div_25f4f259\"></div>"
       ]
      },
      "metadata": {},
@@ -152,7 +152,7 @@
     {
      "data": {
       "text/html": [
-       "<div id=\"dom.transient_div_5b814837\"></div>"
+       "<div id=\"dom.transient_div_759e5c9b\"></div>"
       ]
      },
      "metadata": {},
@@ -197,7 +197,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/functions.ipynb b/examples/tests/functions.ipynb
@@ -65,7 +65,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/goflags.ipynb b/examples/tests/goflags.ipynb
@@ -153,9 +153,9 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "gonb_0cdc700f/main.go:8:\tA\t\t100.0%\n",
-      "gonb_0cdc700f/main.go:12:\tB\t\t0.0%\n",
-      "gonb_0cdc700f/main.go:17:\tmain\t\t100.0%\n",
+      "gonb_ae2bcb52/main.go:8:\tA\t\t100.0%\n",
+      "gonb_ae2bcb52/main.go:12:\tB\t\t0.0%\n",
+      "gonb_ae2bcb52/main.go:17:\tmain\t\t100.0%\n",
       "total\t\t\t\t(statements)\t75.0%\n"
      ]
     }
@@ -238,7 +238,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "# gonb_0cdc700f\n",
+      "# gonb_ae2bcb52\n",
       "./main.go:10:6: can inline (*Point).ManhattanLen\n",
       "./main.go:16:12: inlining call to flag.Parse\n",
       "./main.go:18:27: inlining call to (*Point).ManhattanLen\n",
@@ -267,7 +267,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/gonbui.ipynb b/examples/tests/gonbui.ipynb
@@ -22,7 +22,7 @@
      "output_type": "stream",
      "text": [
       "%goflags=[\"--cover\" \"--covermode=set\"]\n",
-      "GOCOVERDIR=/tmp/gonb_test_coverage.fmW2jDEhWf\n"
+      "GOCOVERDIR=/tmp/gonb_nbtests_gocoverdir_4129479306\n"
      ]
     }
    ],
@@ -133,7 +133,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/gotest.ipynb b/examples/tests/gotest.ipynb
@@ -287,12 +287,12 @@
      "text": [
       "goos: linux\n",
       "goarch: amd64\n",
-      "pkg: gonb_a1453c14\n",
+      "pkg: gonb_74e427f6\n",
       "cpu: 12th Gen Intel(R) Core(TM) i9-12900K\n",
       "BenchmarkFibonacciA32\n",
-      "BenchmarkFibonacciA32-24    \t     169\t   7058908 ns/op\n",
+      "BenchmarkFibonacciA32-24    \t     178\t   6602828 ns/op\n",
       "BenchmarkFibonacciB32\n",
-      "BenchmarkFibonacciB32-24    \t285643864\t         3.680 ns/op\n",
+      "BenchmarkFibonacciB32-24    \t298555876\t         4.021 ns/op\n",
       "PASS\n",
       "coverage: [no statements]\n"
      ]
@@ -334,10 +334,10 @@
      "text": [
       "goos: linux\n",
       "goarch: amd64\n",
-      "pkg: gonb_a1453c14\n",
+      "pkg: gonb_74e427f6\n",
       "cpu: 12th Gen Intel(R) Core(TM) i9-12900K\n",
-      "BenchmarkFibonacciA32-24    \t     168\t   7082427 ns/op\n",
-      "BenchmarkFibonacciB32-24    \t308541147\t         3.901 ns/op\n",
+      "BenchmarkFibonacciA32-24    \t     180\t   6574007 ns/op\n",
+      "BenchmarkFibonacciB32-24    \t308328156\t         3.930 ns/op\n",
       "PASS\n",
       "coverage: [no statements]\n"
      ]
@@ -361,7 +361,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/gowork.ipynb b/examples/tests/gowork.ipynb
@@ -36,7 +36,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "/tmp/gonb_tests_gowork_IBSuBo7n"
+      "/tmp/gonb_tests_gowork_173uIYjd"
      ]
     }
    ],
@@ -64,7 +64,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Temporary test package: /tmp/gonb_tests_gowork_IBSuBo7n\n"
+      "Temporary test package: /tmp/gonb_tests_gowork_173uIYjd\n"
      ]
     }
    ],
@@ -136,7 +136,7 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "\t- Added replace rule for module \"a.com/a/pkg\" to local directory \"/tmp/gonb_tests_gowork_IBSuBo7n\".\n"
+      "\t- Added replace rule for module \"a.com/a/pkg\" to local directory \"/tmp/gonb_tests_gowork_173uIYjd\".\n"
      ]
     }
    ],
@@ -155,9 +155,9 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "module gonb_05a80086\n",
+      "module gonb_b978d03f\n",
       "\n",
-      "go 1.23.2\n",
+      "go 1.23.5\n",
       "\n",
       "replace a.com/a/pkg => TMP_PKG\n"
      ]
@@ -186,7 +186,7 @@
       "text/html": [
        "<b>List of files/directories being tracked:</b>\n",
        "<ul>\n",
-       "<li>/tmp/gonb_tests_gowork_IBSuBo7n</li>\n",
+       "<li>/tmp/gonb_tests_gowork_173uIYjd</li>\n",
        "</ul>\n"
       ]
      },
@@ -208,9 +208,9 @@
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "module gonb_05a80086\n",
+      "module gonb_b978d03f\n",
       "\n",
-      "go 1.23.2\n"
+      "go 1.23.5\n"
      ]
     }
    ],
@@ -280,7 +280,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/hello.ipynb b/examples/tests/hello.ipynb
@@ -99,7 +99,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/init.ipynb b/examples/tests/init.ipynb
@@ -156,7 +156,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/input_boxes.ipynb b/examples/tests/input_boxes.ipynb
@@ -22,7 +22,7 @@
      "output_type": "stream",
      "text": [
       "%goflags=[\"--cover\" \"--covermode=set\"]\n",
-      "GOCOVERDIR=/tmp/gonb_test_coverage.fmW2jDEhWf\n"
+      "GOCOVERDIR=/tmp/gonb_nbtests_gocoverdir_4129479306\n"
      ]
     }
    ],
@@ -196,7 +196,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/script.ipynb b/examples/tests/script.ipynb
@@ -105,7 +105,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/vartuple.ipynb b/examples/tests/vartuple.ipynb
@@ -45,7 +45,7 @@
       "text/html": [
        "<h4>Variables</h4>\n",
        "<ul>\n",
-       "<li><pre>_~653277</pre></li>\n",
+       "<li><pre>_~085390</pre></li>\n",
        "<li><pre>a</pre></li>\n",
        "<li><pre>c</pre></li>\n",
        "</ul>"
@@ -125,7 +125,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/widgets.ipynb b/examples/tests/widgets.ipynb
@@ -95,7 +95,7 @@
     {
      "data": {
       "text/html": [
-       "<div id=\"dom.transient_div_7742ea2e\"></div>"
+       "<div id=\"dom.transient_div_540e2e0c\"></div>"
       ]
      },
      "metadata": {},
@@ -189,7 +189,7 @@
     {
      "data": {
       "text/html": [
-       "<div id=\"dom.transient_div_b5a11420\"></div>"
+       "<div id=\"dom.transient_div_ddd43a51\"></div>"
       ]
      },
      "metadata": {},
@@ -304,7 +304,7 @@
     {
      "data": {
       "text/html": [
-       "<div id=\"dom.transient_div_07bc0111\"></div>"
+       "<div id=\"dom.transient_div_a322648e\"></div>"
       ]
      },
      "metadata": {},
@@ -416,7 +416,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,

diff --git a/examples/tests/writefile.ipynb b/examples/tests/writefile.ipynb
@@ -10,7 +10,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Cell contents written to \"/tmp/gonb_nbtests_writefile_4201179243/poetry.txt\".\n"
+      "Cell contents written to \"/tmp/gonb_nbtests_writefile_2206415683/poetry.txt\".\n"
      ]
     }
    ],
@@ -32,7 +32,7 @@
      "name": "stderr",
      "output_type": "stream",
      "text": [
-      "Cell contents appended to \"/tmp/gonb_nbtests_writefile_4201179243/poetry.txt\".\n"
+      "Cell contents appended to \"/tmp/gonb_nbtests_writefile_2206415683/poetry.txt\".\n"
      ]
     }
    ],
@@ -55,7 +55,7 @@
    "name": "go",
    "nbconvert_exporter": "",
    "pygments_lexer": "",
-   "version": "go1.23.2"
+   "version": "go1.23.5"
   }
  },
  "nbformat": 4,