Skip to content

Commit ca0a631

Browse files
committed
add help page
1 parent 12b457c commit ca0a631

File tree

2 files changed

+58
-0
lines changed

2 files changed

+58
-0
lines changed

_quarto.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@ website:
7272
- keyboard-shortcuts.qmd
7373
- data-explorer.qmd
7474
- connections-pane.qmd
75+
- help-pane.qmd
7576
- run-interactive-apps.qmd
7677
- remote-ssh.qmd
7778
- updating.qmd

help-pane.qmd

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: "Help Pane"
3+
---
4+
5+
6+
The **Help Pane** provides rich, in-editor documentation for Python and R.
7+
It can be used to display information about an object, function, or package.
8+
9+
10+
## Getting Help in Python & R
11+
12+
You can open documentation in the Help Pane using language-specific tools or the keyboard shortcut `F1`. These methods will automatically open the Help pane and display documentation.
13+
14+
::: {.panel-tabset}
15+
16+
### Python
17+
18+
```python
19+
int?
20+
# or
21+
help(int)
22+
```
23+
24+
#### Supported Content
25+
26+
The Help Pane supports the following types of documentation in Python:
27+
28+
- Modules, classes, functions, and objects with docstrings
29+
- Rich rendering for common docstring formats: Google, NumPy, Sphinx, Epytext
30+
31+
32+
### R
33+
34+
```r
35+
?paste0()
36+
# or
37+
help(paste0)
38+
```
39+
40+
#### Supported Content
41+
42+
The Help Pane supports the following types of documentation in R:
43+
44+
- Function and package documentation
45+
- Package vignettes (when available)
46+
47+
:::
48+
49+
50+
The Help Pane includes built-in navigation tools:
51+
52+
- {{< fa search>}} Search – Find keywords within a help page
53+
54+
- {{< fa arrow-left >}} {{< fa arrow-right >}} Back and Forward – Navigate through recent help views
55+
56+
All documentation is fully interlinked, with internal references and copyable code examples available where supported.
57+

0 commit comments

Comments
 (0)