Typos: quick fix #3
Conversation
WalkthroughThis pull request encompasses a comprehensive set of minor corrections across multiple files in the Wini project. The changes primarily involve fixing typographical errors in comments, variable names, documentation, and script descriptions. These corrections span various components of the project, including README files, source code, documentation pages, and macro implementations. The modifications do not introduce any functional changes or alter the core logic of the codebase. Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (10)
🧰 Additional context used🪛 LanguageToolwini-website/src/pages/doc/pages/introduction.md[uncategorized] ~23-~23: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE) [uncategorized] ~23-~23: You might be missing the article “the” here. (AI_EN_LECTOR_MISSING_DETERMINER_THE) wini-website/src/pages/doc/pages/directory_structure/files_at_root.md[style] ~48-~48: Consider an alternative for the overused word “exactly”. (EXACTLY_PRECISELY) 🔇 Additional comments (13)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 11
📜 Review details
Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (34)
examples/htmx/README.md(1 hunks)examples/htmx/macros/src/macros/wini/cache.rs(1 hunks)examples/htmx/scripts/README.md(1 hunks)examples/htmx/src/server.rs(2 hunks)examples/htmx/src/shared/wini/mod.rs(1 hunks)examples/sqlx_test/macros/src/macros/wini/cache.rs(1 hunks)examples/sqlx_test/scripts/README.md(1 hunks)examples/sqlx_test/src/pages/hello/mod.rs(1 hunks)examples/sqlx_test/src/server.rs(3 hunks)examples/sqlx_test/src/shared/wini/mod.rs(1 hunks)wini-cli/src/init/ask.rs(3 hunks)wini-cli/src/init/err.rs(2 hunks)wini-cli/src/init/git.rs(1 hunks)wini-cli/src/just/run.rs(1 hunks)wini-website/macros/src/macros/wini/cache.rs(1 hunks)wini-website/scripts/README.md(1 hunks)wini-website/src/pages/doc/css.sublime-syntax(1 hunks)wini-website/src/pages/doc/pages/concepts/components.md(1 hunks)wini-website/src/pages/doc/pages/concepts/concepts-introduction.md(1 hunks)wini-website/src/pages/doc/pages/concepts/layout.md(1 hunks)wini-website/src/pages/doc/pages/concepts/pages.md(1 hunks)wini-website/src/pages/doc/pages/directory_structure/files_at_root.md(1 hunks)wini-website/src/pages/doc/pages/directory_structure/src_directory.md(1 hunks)wini-website/src/pages/doc/pages/dive/hosting_your_template.md(2 hunks)wini-website/src/pages/doc/pages/introduction.md(1 hunks)wini-website/src/pages/doc/pages/maud/what-is-maud.md(3 hunks)wini-website/src/pages/doc/pages/maud/why-maud.md(2 hunks)wini-website/src/pages/doc/pages/maud/wini-maud.md(1 hunks)wini-website/src/server.rs(2 hunks)wini-website/src/shared/wini/mod.rs(1 hunks)wini/macros/src/macros/wini/cache.rs(1 hunks)wini/scripts/README.md(1 hunks)wini/src/server.rs(2 hunks)wini/src/shared/wini/mod.rs(1 hunks)
🧰 Additional context used
🪛 LanguageTool
wini-website/src/pages/doc/pages/directory_structure/src_directory.md
[style] ~21-~21: The word ‘tho’ is informal. Consider replacing it.
Context: ...red/ ├── template/ └── utils/ ``` Even tho, most of the name are self explicit, we...
(THO)
wini-website/src/pages/doc/pages/maud/wini-maud.md
[uncategorized] ~14-~14: Possible missing comma found.
Context: ...d javascript files. When you declare a component for example, this component might depen...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~14-~14: The modal verb ‘might’ requires the verb’s base form.
Context: ...onent for example, this component might depends on some stylesheets or some scripts. So...
(MD_BASEFORM)
wini-website/src/pages/doc/pages/directory_structure/files_at_root.md
[grammar] ~48-~48: The correct verb form after the modal verb “should” is “include”.
Context: ...e of your script, which files should it includes ? And this is exactly what `packages-fi...
(CAN_I_VBD)
[style] ~48-~48: Consider an alternative for the overused word “exactly”.
Context: ... files should it includes ? And this is exactly what packages-files.toml tries to sol...
(EXACTLY_PRECISELY)
wini-website/src/pages/doc/pages/dive/hosting_your_template.md
[style] ~7-~7: Only include ‘own’ if you want to emphasize that something belongs to a person or thing or was done by a person or thing.
Context: ...e with all of them. Therefore, hosting your own template is really straightforward: 1....
(PRP_OWN)
[style] ~44-~44: Consider using the typographical ellipsis character here instead.
Context: ...on about your remote git repository. And... that's really it! Congrats! ## Update ...
(ELLIPSIS)
[style] ~44-~44: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 849 characters long)
Context: ...itory. And... that's really it! Congrats! ## Update your template Updating your...
(EN_EXCESSIVE_EXCLAMATION)
wini-website/src/pages/doc/pages/concepts/pages.md
[uncategorized] ~44-~44: A period might be missing here.
Context: .... Tho, they don't do exactly the same thing
(AI_EN_LECTOR_MISSING_PUNCTUATION_PERIOD)
wini-website/src/pages/doc/pages/concepts/components.md
[grammar] ~31-~31: The usual collocation for technology is “on”, not “in”.
Context: ... useful when there is some common logic in the website. ## Example ```rs // ./components/my...
(IN_THE_INTERNET)
wini-website/src/pages/doc/pages/introduction.md
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ... of seeing front-end: Front-end is just back-end sending HTML, CSS and web-related f...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[grammar] ~25-~25: Did you mean the commonly used phrase “in terms of”?
Context: ...Because JavaScript is more lightweight (in term of bytes transferred), supported and has a...
(IN_TERM_OF_PHRASE)
wini-website/src/pages/doc/pages/maud/why-maud.md
[style] ~6-~6: The word ‘tho’ is informal. Consider replacing it.
Context: ...r) - It has an elegant syntax. Even tho this is a subjective point, for the vas...
(THO)
[grammar] ~6-~6: Did you mean “fewer”? The noun “characters” is countable.
Context: ... of expressions, Maud has substantially less characters than HTML and incorporate CS...
(FEWER_LESS)
🪛 Markdownlint (0.37.0)
wini-website/src/pages/doc/pages/maud/what-is-maud.md
43-43: Element: div
Inline HTML
(MD033, no-inline-html)
🔇 Additional comments (25)
wini/src/server.rs (1)
20-20: LGTM! Typo fix in variable name.The correction from
comression_layertocompression_layerproperly aligns with the importedCompressionLayertype.Also applies to: 30-30
wini-website/src/server.rs (1)
20-20: LGTM! Consistent typo fix.The correction from
comression_layertocompression_layermaintains consistency with the fix inwini/src/server.rs.Also applies to: 32-32
wini-cli/src/init/err.rs (1)
9-9: LGTM! Spelling correction in error enum.The correction from
AuthentificationtoAuthenticationfixes the spelling in both the enum variant and its corresponding error message.Also applies to: 30-31
examples/htmx/macros/src/macros/wini/cache.rs (1)
87-87: LGTM! Documentation typo fix.The correction from "containg" to "containing" improves the documentation clarity.
wini-website/macros/src/macros/wini/cache.rs (1)
87-87: LGTM! Documentation improvement.The typo fix in the comment improves clarity.
wini-cli/src/init/ask.rs (2)
124-124: LGTM! Documentation improvement.The grammatical correction in the comment improves clarity.
46-46: Function name correction improves API consistency.The function name has been corrected from
from_cutom_local_repositorytofrom_custom_local_repository.Let's verify if there are any remaining references to the old function name:
✅ Verification successful
Function rename verification completed successfully
The function has been correctly renamed from
from_cutom_local_repositorytofrom_custom_local_repositorythroughout the codebase. Both the function definition and its usage have been updated consistently.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining references to the old function name rg "from_cutom_local_repository"Length of output: 32
Script:
#!/bin/bash # Search for the new function name definition and usage rg "from_custom_local_repository" -A 2 # Find function definition using AST pattern ast-grep --pattern 'fn from_custom_local_repository() -> $_'Length of output: 478
examples/sqlx_test/src/pages/hello/mod.rs (1)
26-26: LGTM! Error message improvement.The spelling correction in the error message improves clarity.
Let's check for consistency of this error message across the codebase:
✅ Verification successful
Error message spelling is consistent across the codebase
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Search for any remaining instances of the misspelled error message rg "occured"Length of output: 12
Script:
#!/bin/bash # Search for variations of error messages with "occurred" rg -i "occurred" -A 1Length of output: 247
examples/htmx/README.md (1)
3-3: LGTM!The spelling correction from "transitionning" to "transitioning" improves readability.
wini-cli/src/just/run.rs (1)
13-17: LGTM!The variable name correction from "occurences" to "occurrences" improves code readability while maintaining the same functionality.
examples/htmx/src/server.rs (1)
19-19: LGTM!The variable name correction from "comression_layer" to "compression_layer" improves code readability while maintaining the same functionality.
Also applies to: 29-29
wini-website/src/pages/doc/pages/dive/hosting_your_template.md (1)
7-7: LGTM!The corrections improve the documentation's readability:
- Fixed spelling: "straigthforward" → "straightforward"
- Fixed grammar: "enter informations" → "enter information"
Also applies to: 44-44
🧰 Tools
🪛 LanguageTool
[style] ~7-~7: Only include ‘own’ if you want to emphasize that something belongs to a person or thing or was done by a person or thing.
Context: ...e with all of them. Therefore, hosting your own template is really straightforward: 1....(PRP_OWN)
examples/sqlx_test/src/server.rs (1)
Line range hint
26-47: LGTM! Spelling corrections properly implementedThe changes correctly fix the spelling of:
- Variable name from "comression_layer" to "compression_layer"
- Error message from "An error occured" to "An error occurred"
wini-website/scripts/README.md (1)
23-23: LGTM! Grammar improvementThe change from "current running" to "currently running" improves the grammatical structure while maintaining the intended meaning.
examples/sqlx_test/scripts/README.md (1)
23-23: LGTM! Consistent documentationThe grammatical improvement matches the changes in other README files, maintaining consistency across the project's documentation.
wini/scripts/README.md (1)
23-23: LGTM! Documentation consistency maintainedThe grammatical improvement aligns with similar changes across other README files in the project.
examples/htmx/scripts/README.md (1)
23-23: LGTM! Documentation consistency completeThe grammatical improvement completes the consistent update across all script README files in the project.
examples/sqlx_test/src/shared/wini/mod.rs (1)
9-11: LGTM! Clear documentationThe documentation comment clearly describes the purpose of the
PUBLIC_ENDPOINTSstatic variable.examples/htmx/src/shared/wini/mod.rs (1)
9-9: Documentation typo fix looks good!The correction from "endoints" to "endpoints" improves the clarity of the documentation.
wini/src/shared/wini/mod.rs (1)
9-9: Documentation fix maintains consistency!The correction aligns with the same fix in other mod.rs files, maintaining documentation consistency across the codebase.
wini-website/src/shared/wini/mod.rs (1)
9-9: Documentation fix completes the consistency pattern!The correction completes the standardization of "endpoints" across all mod.rs files.
wini-website/src/pages/doc/pages/maud/what-is-maud.md (1)
8-8: Documentation improvements enhance clarity!The changes improve readability and correctness of the Maud documentation through multiple fixes:
- Better resource reference
- Clearer attributes explanation
- Improved div inference description
- Better control flow statement explanation
Also applies to: 37-37, 45-45, 72-72
examples/sqlx_test/macros/src/macros/wini/cache.rs (1)
87-87: LGTM!The typo fix in the comment is correct.
wini/macros/src/macros/wini/cache.rs (1)
87-87: LGTM!The typo fix in the comment is correct and consistent with the same fix in the SQLx test macros.
wini-cli/src/init/git.rs (1)
20-20: LGTM!The spelling correction in the error message is appropriate.
wini-website/src/pages/doc/pages/concepts/concepts-introduction.md
Outdated
Show resolved
Hide resolved
wini-website/src/pages/doc/pages/directory_structure/src_directory.md
Outdated
Show resolved
Hide resolved
wini-website/src/pages/doc/pages/directory_structure/files_at_root.md
Outdated
Show resolved
Hide resolved
|
Thanks a lot for you PR! Ill look at it soon! Im working on other projects at this time, but I'll come back at wini soon :) |
…roduction.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…tructure/src_directory.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…iles_at_root.md Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Hey,
I've made a quick check against typos and fixed them. I'll read more carefully the documentation next tiem and ask for another PR if I see other stuff.
Cool project ! I'm curious to understand how it works in details :)
Summary by CodeRabbit
Documentation
Chores
comression_layer→compression_layer).