Fixed IsZoomControlEnabled and ZoomFactor option docs #3137
Conversation
WalkthroughThe unidiff snippet shows changes in the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ? TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 5
Configuration used: CodeRabbit UI
Files selected for processing (1)
- website/docs/reference/options.mdx (2 hunks)
Additional comments: 4
website/docs/reference/options.mdx (4)
85-88: The documentation for
ZoomFactorandIsZoomControlEnabledhas been reintroduced with clear comments explaining their purpose. This aligns with the PR's objective to fix the documentation for these options.90-90: The
Messagesfield has been updated with a colon for type annotation, which is consistent with the summary mentioning syntax updates for better clarity.92-92: The
OnSuspendfield has been updated to use a colon for function declaration, which matches the summary's note on syntax modifications.94-94: The
OnResumefield has been updated to use a colon for function declaration, aligning with the summary's mention of syntax changes.
| @@ -84,12 +82,17 @@ func main() { | |||
| LightModeTitleText: windows.RGB(20, 20, 20), | |||
| LightModeBorder: windows.RGB(200, 200, 200), | |||
| }, | |||
| // ZoomFactor is the zoom factor for the WebView2. This is the option matching the Edge user activated zoom in or out. | |||
| ZoomFactor: float64, | |||
There was a problem hiding this comment.
The type for ZoomFactor is indicated as float64 in the comment, but the actual type is not provided in the documentation. The documentation should specify the type to maintain consistency and clarity.
| // ZoomFactor is the zoom factor for the WebView2. This is the option matching the Edge user activated zoom in or out. | ||
| ZoomFactor: float64, | ||
| // IsZoomControlEnabled enables the zoom factor to be changed by the user. | ||
| IsZoomControlEnabled: bool, |
There was a problem hiding this comment.
Similarly, the type for IsZoomControlEnabled is indicated as bool in the comment, but the actual type is not provided in the documentation. The documentation should specify the type to maintain consistency and clarity.
| // User messages that can be customised | ||
| Messages *windows.Messages | ||
| Messages: *windows.Messages |
There was a problem hiding this comment.
The Messages field is missing the actual type definition in the documentation. It should be provided to ensure that the documentation is complete and accurate.
| // OnSuspend is called when Windows enters low power mode | ||
| OnSuspend func() | ||
| OnSuspend: func() |
There was a problem hiding this comment.
The OnSuspend field is missing the actual type definition in the documentation. It should be provided to ensure that the documentation is complete and accurate.
| // OnResume is called when Windows resumes from low power mode | ||
| OnResume func(), | ||
| OnResume: func(), |
There was a problem hiding this comment.
The OnResume field is missing the actual type definition in the documentation. It should be provided to ensure that the documentation is complete and accurate.
Deploying with
|
| Latest commit: |
f6b450b
|
| Status: | ⚡️ Build in progress... |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- website/src/pages/changelog.mdx (1 hunks)
Additional comments: 1
website/src/pages/changelog.mdx (1)
- 23-24: Please ensure that all relevant changes, including those to
Messages,OnSuspend,OnResume, and the introduction ofWebviewGpuDisabled, are documented in the changelog if they are part of the pull request. The changelog should provide a complete and accurate history of changes for users and developers.
Description
Updated the options document to reflect the two options.
Summary by CodeRabbit
ZoomFactorandIsZoomControlEnabledwith additional comments for clarity.Messages,OnSuspend, andOnResume.WebviewGpuDisabledoption in theWindowssection.