Skip to content

Commit f755a9a

Browse files
authored
Add jupyterlab help section (#101)
1 parent 9b0b44d commit f755a9a

File tree

3 files changed

+43
-2
lines changed

3 files changed

+43
-2
lines changed

source/img/completion_menu.png

35.4 KB
Loading

source/img/help_dialog.png

91.6 KB
Loading

source/intro.md

+43-2
Original file line numberDiff line numberDiff line change
@@ -1099,9 +1099,50 @@ The documentation for the read_csv function including a high-level description,
10991099

11001100
+++
11011101

1102-
If you are working in a Jupyter Lab environment, there are also two more convenient
1103-
ways to access documentation for functions. **JOEL ADD TEXT AND IMAGES HERE**.
1102+
If you are working in a Jupyter Lab environment, there are some conveniences that will help you lookup function names
1103+
and access the documentation.
1104+
You can type the first characters of the function you want to use,
1105+
and then press <kbd>Tab</kbd> to bring up small menu
1106+
that shows you all the available functions
1107+
that starts with those characters.
1108+
This is helpful both for remembering function names
1109+
and to prevent typos.
11041110

1111+
+++
1112+
1113+
```{figure} img/completion_menu.png
1114+
---
1115+
height: 400px
1116+
name: completion_menu
1117+
---
1118+
The suggestions that are shown after typing `pd.read` and pressing <kbd>Tab</kbd>.
1119+
```
1120+
1121+
+++
1122+
1123+
To get more info on the function you want to use,
1124+
you can type out the full name
1125+
and then hold <kbd>Shift</kbd> while pressing <kbd>Tab</kbd>
1126+
to bring up a help dialogue including the same information as when using `help()`.
1127+
1128+
+++
1129+
1130+
```{figure} img/help_dialog.png
1131+
---
1132+
height: 400px
1133+
name: help_dialog
1134+
---
1135+
The help dialog that is shown after typing `pd.read_csv` and then pressing <kbd>Shift</kbd> + <kbd>Tab</kbd>.
1136+
```
1137+
1138+
+++
1139+
1140+
Finally,
1141+
it can be helpful to have this help dialog open at all times,
1142+
especially when you start out learning about programming and data science.
1143+
You can achieve this by clicking on the `Help` text
1144+
in the menu bar at the top
1145+
and then selecting `Show Contextual Help`.
11051146

11061147
## Exercises
11071148

0 commit comments

Comments
 (0)