Skip to content

Commit 70f8b18

Browse files
committed
🎨 add cross-reference to api doc and print docstring
1 parent 53eeab0 commit 70f8b18

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/tutorial/tutorial.ipynb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,9 @@
6565
"id": "076361ca",
6666
"metadata": {},
6767
"source": [
68-
"Inspect the signature."
68+
"Inspect the signature. In an interactive session you could also use `hello_world?` to\n",
69+
"display the docstring. See the rendered version here:\n",
70+
"[reference/python_package.mockup](python_package.mockup.hello_world)"
6971
]
7072
},
7173
{
@@ -75,7 +77,7 @@
7577
"metadata": {},
7678
"outputs": [],
7779
"source": [
78-
"hello_world?"
80+
"help(hello_world)"
7981
]
8082
},
8183
{

docs/tutorial/tutorial.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,12 @@
2323
print(ret)
2424

2525
# %% [markdown]
26-
# Inspect the signature.
26+
# Inspect the signature. In an interactive session you could also use `hello_world?` to
27+
# display the docstring. See the rendered version
28+
# [of `hello_world` under the Reference]](python_package.mockup.hello_world)
2729

2830
# %%
29-
# hello_world?
31+
help(hello_world)
3032

3133
# %% [markdown]
3234
# Simple example for a recipe showing what the package can do.

0 commit comments

Comments
 (0)