Improve Qt Introduction #10
Draft
Conversation
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
✅ Deploy Preview for spyder-api-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
CAM-Gerlach
changed the title
CAM-Gerlach
reviewed
Dec 24, 2024
docs/qt_introduction.md
Outdated
| The user has to end the interaction with the modal dialog and close it to access to any other window in the application. | ||
| For example, dialogs for requesting information or selecting preferences for an application may be modal. | ||
| A modeless dialog operates independently of other windows of the same application. | ||
| For example, find and replace dialogs allow the user to interact with both the modeless dialog and the application's main window. | ||
|
|
||
| Qt provides some *special dialogs* for the most common use-cases as *file Open/Save*, *font selection*, *error messages*, *color choosing*, *printing*, among others. |
There was a problem hiding this comment.
Suggested change
| Qt provides some *special dialogs* for the most common use-cases as *file Open/Save*, *font selection*, *error messages*, *color choosing*, *printing*, among others. | |
| Qt provides some standard dialogs for the most common use cases, such as *file Open/Save*, *error messages*, *color choosing*, *printing*, among others. |
CAM-Gerlach
reviewed
Dec 24, 2024
docs/qt_introduction.md
Outdated
|
|
||
| **Slot** is a function that is invoked in response to a specific signal. | ||
| Functions or methods could be used as slots, by connecting a signal to them. | ||
| If a signal sends data, the receiver callable will also receive it. |
There was a problem hiding this comment.
Suggested change
| If a signal sends data, the receiver callable will also receive it. | |
| If a signal sends data, the slot function will be called with it. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Pull Request
Pull Request Checklist
Description of Changes
This pull request includes the improvement of the Qt introduction page.
I have enriched the descriptions of the sections taking into account the official Qt documentation.
After the changes, I was not sure about the following text description:
Dialog section
"Dialogs are commonly used for functions that do not fit into the main interface."
"Qt provides some special dialogs for the most common use-cases as file Open/Save, font selection, error messages, color choosing, printing, among others."
Signals & Slots section
"Functions or methods could be used as slots, by connecting a signal to them."
"If a signal sends data, the receiver callable will also receive it."
Please validate them.
Thanks