Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ website:
- keyboard-shortcuts.qmd
- data-explorer.qmd
- connections-pane.qmd
- help-pane.qmd
- run-interactive-apps.qmd
- remote-ssh.qmd
- updating.qmd
Expand Down
57 changes: 57 additions & 0 deletions help-pane.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
---
title: "Help Pane"
---


The **Help Pane** provides rich, in-editor documentation for Python and R.
It can be used to display information about an object, function, or package.


## Getting Help in Python & R

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.

::: {.panel-tabset}

### Python

```python
int?
# or
help(int)
```

#### Supported Content

The Help Pane supports the following types of documentation in Python:

- Modules, classes, functions, and objects with docstrings
- Rich rendering for common docstring formats: Google, NumPy, Sphinx, Epytext


### R

```r
?paste0()
# or
help(paste0)
```

#### Supported Content

The Help Pane supports the following types of documentation in R:

- Function and package documentation
- Package vignettes (when available)
Comment on lines +45 to +46
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is what is in the RStudio user guide, do we want to be more specific?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good as is!


:::


The Help Pane includes built-in navigation tools:

- {{< fa search>}} Search – Find keywords within a help page

- {{< fa arrow-left >}} {{< fa arrow-right >}} Back and Forward – Navigate through recent help views

All documentation is fully interlinked, with internal references and copyable code examples available where supported.

Loading