-
Notifications
You must be signed in to change notification settings - Fork 822
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
Improve Context Menu Documentation #3945
Open
Nadiya-Shaikh
wants to merge
1
commit into
sugarlabs:master
Choose a base branch
from
Nadiya-Shaikh:improved-documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+11
−2
Open
Changes from all commits
Commits
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 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 |
---|---|---|
|
@@ -122,11 +122,20 @@ This option removes the selected block from your program | |
![Delete](./delete.png "Delete") | ||
|
||
# Help | ||
This option shows a help screen with information about the selected block. You can use this option to learn more about the block's functionality and how to use it in your projects. | ||
Help | ||
The "Help" option shows a detailed help screen with information about the selected block. It includes descriptions of the block's functionality, usage instructions, and examples to help users understand how to incorporate the block into their projects effectively. | ||
|
||
![Help](./help.png "Help") | ||
|
||
By using the right-click context menu in Music Blocks, you can quickly perform common tasks and manipulate blocks on the workspace. This can help you to work more efficiently and effectively in your projects. | ||
Example Usage: | ||
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. I am not sure that the text beginning at Line 130 adds any value. But you may want to mention that many help screens allow you do insert the example blocks into your program by clicking on the download icon (Load this block). |
||
|
||
Right-click on a complex block to access its help screen. This provides insights into its properties, parameters, and practical applications within your project. | ||
Benefits: | ||
|
||
Enhanced Understanding: Gain a deeper understanding of each block's purpose and functionality. | ||
Efficiency: Quickly access relevant information without leaving the workspace, improving workflow efficiency. | ||
|
||
By utilizing the right-click context menu in Music Blocks, you can perform common tasks swiftly and manipulate blocks efficiently, aiding in more effective project development. | ||
|
||
Keyboard shortcuts | ||
------------------ | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we need Help on this line? It is already on Line 124.