Skip to content
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

Fix typos #3628

Merged
merged 5 commits into from
Aug 20, 2024
Merged

Fix typos #3628

merged 5 commits into from
Aug 20, 2024

Conversation

deining
Copy link
Contributor

@deining deining commented Jul 22, 2024

This PR fixes a few typos I spotted in the project.

Summary by CodeRabbit

  • Documentation
    • Corrected minor typographical errors across several documents to improve clarity and professionalism, including:
      • "specifiy" to "specifying"
      • "comma seperated" to "comma separated"
      • "application" spelling corrections
      • "doesnt" to "doesn't"
      • "Miminal" to "Minimal"
      • "classs" to "class"
      • "envrionment" to "environment"
      • "listeneres" to "listeners"
      • "tha" to "the" in print dialog description.
  • New Features
    • Windows-specific enhancements include restricting ZoomFactor and IsZoomControlEnabled options to the Windows environment.
    • Introduced a nil check for Drag-and-Drop functionality on Windows to improve error handling and robustness.

Copy link
Contributor

coderabbitai bot commented Jul 22, 2024

Walkthrough

This update enhances documentation and functionality across multiple files, correcting typographical errors for increased clarity and professionalism. Key changes include improved instructions, spelling corrections, and significant adjustments to Windows-specific options and error handling. These enhancements contribute to a more robust application performance and provide users with clearer guidance, ultimately leading to a more polished and user-friendly documentation experience.

Changes

Files Grouped Together Change Summary
website/docs/guides/* Corrected various typographical errors for clarity, including "specifiy" to "specifying," "comma seperated" to "comma separated," and others.
website/docs/howdoesitwork.mdx Renamed parameter classs to class in the convertValues method for improved clarity without affecting functionality.
website/src/pages/changelog.mdx Updated Windows-specific options and introduced error handling for Drag-and-Drop functionality; restricted ZoomFactor and IsZoomControlEnabled to Windows.

Poem

🐇 In the land of code, where rabbits roam,
We fixed some words to make it home!
From "specifiy" to "specifying" bright,
Our docs now shine with clearer light.
With typos gone, we hop with glee,
A polished guide for all to see! 🌟


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 your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (3)
website/docs/guides/nixos-font.mdx (1)

3-3: Typographical correction approved. Consider adding a comma.

The correction from "doesnt" to "doesn't" is appropriate. For better readability, consider adding a comma after "To fix this".

- To fix this add the following to your devShell.
+ To fix this, add the following to your devShell.
Tools
LanguageTool

[uncategorized] ~3-~3: Possible missing comma found.
Context: ...oesn't affect the rendered page. To fix this add the following to your devShell. ``...

(AI_HYDRA_LEO_MISSING_COMMA)

website/docs/guides/mac-appstore.mdx (1)

65-65: Typographical correction approved. Consider varying the phrasing.

The correction from "appliaction" to "application" is appropriate. For better style, consider varying the phrasing to avoid repetition.

- It needs to be named embedded.provisionprofile.
+ Name it embedded.provisionprofile.
Tools
LanguageTool

[style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...dded to the root of the application. It needs to be named embedded.provisionprofile. ##...

(REP_NEED_TO_VB)

website/docs/reference/cli.mdx (1)

72-72: Typographical correction approved. Consider additional corrections.

The correction from "envrionment" to "environment" is appropriate. For better clarity and correctness, consider the following additional corrections:

  • Change "eg" to "e.g."
  • Add a hyphen in "comma delimited"
- eg. `windows/arm64`. Note, if you do not give the architecture, `runtime.GOARCH` is used.
+ e.g., `windows/arm64`. Note, if you do not give the architecture, `runtime.GOARCH` is used.
Tools
LanguageTool

[misspelling] ~72-~72: This word is normally spelled with a hyphen.
Context: ...tform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platf...

(EN_COMPOUNDS_COMMA_DELIMITED)


[uncategorized] ~72-~72: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tforms](../reference/cli.mdx#platforms) eg. windows/arm64. Note, if you do not gi...

(E_G)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 7a40cc5 and 85a6288.

Files selected for processing (9)
  • website/docs/guides/application-development.mdx (1 hunks)
  • website/docs/guides/frontend.mdx (1 hunks)
  • website/docs/guides/mac-appstore.mdx (1 hunks)
  • website/docs/guides/nixos-font.mdx (1 hunks)
  • website/docs/guides/sveltekit.mdx (2 hunks)
  • website/docs/howdoesitwork.mdx (1 hunks)
  • website/docs/reference/cli.mdx (1 hunks)
  • website/docs/reference/runtime/events.mdx (1 hunks)
  • website/docs/reference/runtime/window.mdx (1 hunks)
Files skipped from review due to trivial changes (6)
  • website/docs/guides/application-development.mdx
  • website/docs/guides/frontend.mdx
  • website/docs/guides/sveltekit.mdx
  • website/docs/howdoesitwork.mdx
  • website/docs/reference/runtime/events.mdx
  • website/docs/reference/runtime/window.mdx
Additional context used
LanguageTool
website/docs/guides/nixos-font.mdx

[uncategorized] ~3-~3: Possible missing comma found.
Context: ...oesn't affect the rendered page. To fix this add the following to your devShell. ``...

(AI_HYDRA_LEO_MISSING_COMMA)

website/docs/guides/mac-appstore.mdx

[style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...dded to the root of the application. It needs to be named embedded.provisionprofile. ##...

(REP_NEED_TO_VB)

website/docs/reference/cli.mdx

[misspelling] ~72-~72: This word is normally spelled with a hyphen.
Context: ...tform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platf...

(EN_COMPOUNDS_COMMA_DELIMITED)


[uncategorized] ~72-~72: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tforms](../reference/cli.mdx#platforms) eg. windows/arm64. Note, if you do not gi...

(E_G)

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)
website/docs/guides/mac-appstore.mdx (1)

65-65: LGTM! Consider rephrasing for variety.

The correction of the spelling error is accurate. For better readability, consider rephrasing the sentence to avoid repetition.

- The Provisioning Profile created above needs to be added to the root of the application. It needs to be named embedded.provisionprofile.
+ Add the Provisioning Profile created above to the root of the application, naming it embedded.provisionprofile.
Tools
LanguageTool

[style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...dded to the root of the application. It needs to be named embedded.provisionprofile. ##...

(REP_NEED_TO_VB)

website/docs/reference/cli.mdx (1)

72-72: LGTM! Consider minor improvements.

The correction of the spelling error is accurate. For better clarity and adherence to writing conventions, consider the following improvements:

- Build for the given (comma delimited) [platforms](../reference/cli.mdx#platforms) eg. `windows/arm64`.
+ Build for the given (comma-delimited) [platforms](../reference/cli.mdx#platforms), e.g., `windows/arm64`.
Tools
LanguageTool

[misspelling] ~72-~72: This word is normally spelled with a hyphen.
Context: ...tform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platf...

(EN_COMPOUNDS_COMMA_DELIMITED)


[uncategorized] ~72-~72: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tforms](../reference/cli.mdx#platforms) eg. windows/arm64. Note, if you do not gi...

(E_G)

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 85a6288 and a8a3be9.

Files selected for processing (9)
  • website/docs/guides/application-development.mdx (1 hunks)
  • website/docs/guides/frontend.mdx (1 hunks)
  • website/docs/guides/mac-appstore.mdx (1 hunks)
  • website/docs/guides/nixos-font.mdx (1 hunks)
  • website/docs/guides/sveltekit.mdx (2 hunks)
  • website/docs/howdoesitwork.mdx (1 hunks)
  • website/docs/reference/cli.mdx (1 hunks)
  • website/docs/reference/runtime/events.mdx (1 hunks)
  • website/docs/reference/runtime/window.mdx (1 hunks)
Files skipped from review due to trivial changes (4)
  • website/docs/guides/application-development.mdx
  • website/docs/guides/frontend.mdx
  • website/docs/guides/sveltekit.mdx
  • website/docs/reference/runtime/events.mdx
Files skipped from review as they are similar to previous changes (3)
  • website/docs/guides/nixos-font.mdx
  • website/docs/howdoesitwork.mdx
  • website/docs/reference/runtime/window.mdx
Additional context used
LanguageTool
website/docs/guides/mac-appstore.mdx

[style] ~65-~65: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...dded to the root of the application. It needs to be named embedded.provisionprofile. ##...

(REP_NEED_TO_VB)

website/docs/reference/cli.mdx

[misspelling] ~72-~72: This word is normally spelled with a hyphen.
Context: ...tform | Build for the given (comma delimited) [platforms](../reference/cli.mdx#platf...

(EN_COMPOUNDS_COMMA_DELIMITED)


[uncategorized] ~72-~72: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...tforms](../reference/cli.mdx#platforms) eg. windows/arm64. Note, if you do not gi...

(E_G)

@deining deining requested a review from leaanthony July 22, 2024 20:58
@leaanthony
Copy link
Member

Thanks 🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

@deining
Copy link
Contributor Author

deining commented Aug 18, 2024

Thanks 🙏

You are welcome!

Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

Done!

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (1)
website/src/pages/changelog.mdx (1)

26-26: Ensure consistency in changelog entries.

The entry "Fixed typos in various .mdx files" is clear and concise. Ensure that similar entries throughout the changelog are consistent in style and detail.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a8a3be9 and b942d9a.

Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)

Copy link

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between b942d9a and cd14125.

Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • website/src/pages/changelog.mdx

@leaanthony leaanthony merged commit 868931f into wailsapp:master Aug 20, 2024
13 checks passed
therealsamf pushed a commit to therealsamf/wails that referenced this pull request Aug 29, 2024
* Fix typos

* Update howdoesitwork.mdx

* Added entry to changelog

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants