-
Notifications
You must be signed in to change notification settings - Fork 29
docs: Help Pane #73
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
docs: Help Pane #73
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ca0a631
add help page
isabelizimm 878bc06
lint
isabelizimm db8545d
one sentence per line
isabelizimm 3572718
add copilot instructions
isabelizimm dfefe66
Apply suggestions from code review
isabelizimm 4c4bd22
Apply suggestions from code review
isabelizimm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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() | ||
isabelizimm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| # or | ||
| help(paste0) | ||
| ``` | ||
|
|
||
| #### Supported Content | ||
isabelizimm marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| 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
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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?
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.