Fix typo aslo #81
Fix typo aslo #81
Conversation
|
WalkthroughThe change involves correcting a typo in the documentation related to encoding and decoding within a Svelte component. There are no modifications to the actual functionality or the declarations of exported or public entities. This update ensures the documentation is accurate and clear for users. Changes
Poem
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
✅ Deploy Preview for sveltekit-search-params ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range and nitpick comments (6)
README.md (6)
Line range hint
133-133: Correct the typo in "rely".- don't relay on the assumption that the store will always be not null + don't rely on the assumption that the store will always be not nullTools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Line range hint
92-92: Replace informal language for professionalism.- but more often than not tho we are not working with strings. + but more often than not, we are not working with strings.Tools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Line range hint
394-394: Add a comma for clarity.- By default the search params are sorted to allow for better cache-ability. + By default, the search params are sorted to allow for better cache-ability.Tools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Line range hint
390-390: Correct verb agreement.- A boolean defining if the history have to be written at all. + A boolean defining if the history has to be written at all.Tools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Line range hint
218-218: Simplify language for clarity.- despite the fact that they are present or not. + whether they are present or not.Tools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Line range hint
21-21: Strengthen the wording for a more assertive tone.- but if you found a problem or have an idea feel free to + but if you encounter a problem or have an idea, please feel free toTools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[style] ~21-~21: Consider using a different verb to strengthen your wording. (FIND_ENCOUNTER)
Context: ...her a contributing guideline but if you found a problem or have an idea feel free to ...
[uncategorized] ~55-~55: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...s not a query parameter with the chosen name it will simply be null. ### Writing to...
[uncategorized] ~59-~59: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...meter) Reading query parameters is cool but you know what is even cooler? Writing q...
[typographical] ~59-~59: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ...er? Writing query parameters! With this library you can treat your store just like norm...
[uncategorized] ~59-~59: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... update the state and conseguentely the url you can just do this ```svelte <script...
[uncategorized] ~91-~91: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ... }} /> ``` ### Encoding and decoding By default query parameters are strings but more o...
[style] ~92-~92: The word ‘tho’ is informal. Consider replacing it. (THO)
Context: ...ers are strings but more often than not tho we are not working with strings. We are...
[grammar] ~92-~92: The verb ‘encode’ does not usually follow articles like ‘an’. Check that ‘encode’ is spelled correctly; using ‘encode’ as a noun may be non-standard. (A_INFINITIVE)
Context: ...re you can specify an object containing an encode and a decode property that will be used...
[misspelling] ~133-~133: Did you mean “rely” (= depend on with full trust)? (RELAY_RELY)
Context: ...ve the null value (this is to say don't relay on the assumption that the store will a...
[grammar] ~137-~137: The verb ‘encode’ does not usually follow articles like ‘an’. Check that ‘encode’ is spelled correctly; using ‘encode’ as a noun may be non-standard. (A_INFINITIVE)
Context: ... Helpers encodings and decodings Write an encode and decode function may seem trivial bu...
[uncategorized] ~137-~137: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ode and decode function may seem trivial but it's tedious for sure. `sveltekit-searc...
[uncategorized] ~150-~150: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...he same output as the code written above but far more readable and easier to read. Y...
[uncategorized] ~190-~190: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...: "svelte", "isCool": "true" } ``` by default all query parameters are string. ### W...
[uncategorized] ~194-~194: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...s) Just like with the single parameter case you can just update the store and the U...
[grammar] ~217-~217: Consider using “most of the time” if you mean “usually” or “very often”. (MOST_OF_THE_TIMES)
Context: ...e time. ### Expecting some parameters Most of the times if you need to read from query paramete...
[style] ~218-~218: “despite the fact that” is a wordy phrase. Consider making your sentence clearer. (ALTHOUGH_CLARITY)
Context: ...merged with the actual query parameters despite the fact that they are present or not. ```svelte <sc...
[grammar] ~244-~244: There is an agreement error between ‘add’ and ‘username’. Insert ‘a(n)’ or change the noun to plural. (PRP_VB_NN)
Context: ... "true", "username": null } ``` if we add username to the URL like this `/?framework=svelt...
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
[typographical] ~288-~288: It appears that a comma is missing. (DURING_THAT_TIME_COMMA)
Context: ... a string anymore. With this particular transformation we've assured that if the url is the fo...
[typographical] ~299-~299: Consider adding a comma after ‘Obviously’ for more clarity. (RB_LY_COMMA)
Context: ...` ### Helpers encodings and decodings Obviously also in this case you can use the helpe...
[uncategorized] ~319-~319: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...e> ``` ## ssp - Helpers There are six helpers all exported as functions on the object...
[uncategorized] ~358-~358: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...cript $store.bool; //true ``` as we've seen an url like this/?bool=falsewill be...
[uncategorized] ~368-~368: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...### string This is exported mainly for readability since all query parameters are already ...
[style] ~386-~386: Consider inserting a comma for improved readability. (MISSING_COMMAS)
Context: ...avoid cluttering the history of the user especially when a store is bound to an input text ...
[grammar] ~390-~390: “History” is a singular noun. It appears that the verb form is incorrect. (PCT_SINGULAR_NOUN_PLURAL_VERB_AGREEMENT)
Context: ...tory A boolean defining if the history have to be written at all. If set to false n...
[uncategorized] ~390-~390: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ...history stack (the URL will still update but the user will not be able to go back wi...
[uncategorized] ~394-~394: Did you mean: “By default,”? (BY_DEFAULT_COMMA)
Context: ...act with a store, it navigates for you. By default the search params are sorted to allow f...
[misspelling] ~394-~394: Did you mean “then”? (AND_THAN)
Context: ...that has this option set tofalseand than interact with one that has this option ...
[uncategorized] ~398-~398: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...ify a default value for the search param and it's not present by default the library...
[uncategorized] ~398-~398: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...he search param and it's not present by default the library will immediately navigate t...
[typographical] ~398-~398: After the expression ‘for example’ a comma is usually used. (COMMA_FOR_EXAMPLE)
Context: ... contains the default search param. For example if you have this code ```svelte <scrip...
[uncategorized] ~408-~408: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...you navigate to/as soon as the page load it will be redirected to/?pageNum=0....
[typographical] ~420-~420: Consider adding a comma after this introductory phrase. (BY_DOING_SO_COMMA)
Context: ...ts: false, }); </script> ``` By doing so the store will still have a value of 0 ...
[uncategorized] ~420-~420: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE_2)
Context: ... of 0 if the search param is not present but the user will not be redirected to `/?p...
[style] ~424-~424: Consider using a different verb for a more formal wording. (FIX_RESOLVE)
Context: ...le times during a single navigation. To fix this problem by default we check if the...
[uncategorized] ~426-~426: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short). (COMMA_COMPOUND_SENTENCE)
Context: ...reactivity. This is fine for most cases and you will likely never touch this option...
[uncategorized] ~426-~426: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ... you will likely never touch this option but if you have some use case not covered b...
[style] ~428-~428: ‘exactly the same’ might be wordy. Consider a shorter alternative. (EN_WORDINESS_PREMIUM_EXACTLY_THE_SAME)
Context: ... to check that every query parameter is exactly the same before returningtrue). ```svelte <s...
[typographical] ~442-~442: The word “hence” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence. (THUS_SENTENCE)
Context: ... function will not be used on primitive values, hence you can't pass the equality function to...
[typographical] ~446-~446: It seems that a comma is missing. (IN_ORDER_TO_VB_COMMA)
Context: ...How to use it To set the configuration object you can pass it as a third parameter in...
[uncategorized] ~471-~471: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...cies error If you ran into issues with vite you need to update your `vite.config.ts...
[style] ~487-~487: Consider using “outdated” to strengthen your wording. (OLD_VERSION)
Context: ...ep is required if you are running on an old version of vite/sveltekit
Markdownlint
README.md
321-321: Expected: h3; Actual: h4 (MD001, heading-increment)
Heading levels should only increment by one level at a time
47-47: Column: 1 (MD010, no-hard-tabs)
Hard tabs
49-49: Column: 1 (MD010, no-hard-tabs)
Hard tabs
63-63: Column: 1 (MD010, no-hard-tabs)
Hard tabs
65-65: Column: 1 (MD010, no-hard-tabs)
Hard tabs
76-76: Column: 1 (MD010, no-hard-tabs)
Hard tabs
78-78: Column: 1 (MD010, no-hard-tabs)
Hard tabs
83-83: Column: 1 (MD010, no-hard-tabs)
Hard tabs
84-84: Column: 1 (MD010, no-hard-tabs)
Hard tabs
85-85: Column: 1 (MD010, no-hard-tabs)
Hard tabs
86-86: Column: 1 (MD010, no-hard-tabs)
Hard tabs
96-96: Column: 1 (MD010, no-hard-tabs)
Hard tabs
98-98: Column: 1 (MD010, no-hard-tabs)
Hard tabs
99-99: Column: 1 (MD010, no-hard-tabs)
Hard tabs
100-100: Column: 1 (MD010, no-hard-tabs)
Hard tabs
101-101: Column: 1 (MD010, no-hard-tabs)
Hard tabs
116-116: Column: 1 (MD010, no-hard-tabs)
Hard tabs
118-118: Column: 1 (MD010, no-hard-tabs)
Hard tabs
119-119: Column: 1 (MD010, no-hard-tabs)
Hard tabs
120-120: Column: 1 (MD010, no-hard-tabs)
Hard tabs
121-121: Column: 1 (MD010, no-hard-tabs)
Hard tabs
122-122: Column: 1 (MD010, no-hard-tabs)
Hard tabs
141-141: Column: 1 (MD010, no-hard-tabs)
Hard tabs
143-143: Column: 1 (MD010, no-hard-tabs)
Hard tabs
156-156: Column: 1 (MD010, no-hard-tabs)
Hard tabs
158-158: Column: 1 (MD010, no-hard-tabs)
Hard tabs
171-171: Column: 1 (MD010, no-hard-tabs)
Hard tabs
173-173: Column: 1 (MD010, no-hard-tabs)
Hard tabs
185-185: Column: 1 (MD010, no-hard-tabs)
Hard tabs
186-186: Column: 1 (MD010, no-hard-tabs)
Hard tabs
198-198: Column: 1 (MD010, no-hard-tabs)
Hard tabs
200-200: Column: 1 (MD010, no-hard-tabs)
Hard tabs
207-207: Column: 1 (MD010, no-hard-tabs)
Hard tabs
208-208: Column: 1 (MD010, no-hard-tabs)
Hard tabs
209-209: Column: 1 (MD010, no-hard-tabs)
Hard tabs
210-210: Column: 1 (MD010, no-hard-tabs)
Hard tabs
222-222: Column: 1 (MD010, no-hard-tabs)
Hard tabs
224-224: Column: 1 (MD010, no-hard-tabs)
Hard tabs
225-225: Column: 1 (MD010, no-hard-tabs)
Hard tabs
226-226: Column: 1 (MD010, no-hard-tabs)
Hard tabs
238-238: Column: 1 (MD010, no-hard-tabs)
Hard tabs
239-239: Column: 1 (MD010, no-hard-tabs)
Hard tabs
240-240: Column: 1 (MD010, no-hard-tabs)
Hard tabs
248-248: Column: 1 (MD010, no-hard-tabs)
Hard tabs
249-249: Column: 1 (MD010, no-hard-tabs)
Hard tabs
250-250: Column: 1 (MD010, no-hard-tabs)
Hard tabs
260-260: Column: 1 (MD010, no-hard-tabs)
Hard tabs
262-262: Column: 1 (MD010, no-hard-tabs)
Hard tabs
263-263: Column: 1 (MD010, no-hard-tabs)
Hard tabs
264-264: Column: 1 (MD010, no-hard-tabs)
Hard tabs
265-265: Column: 1 (MD010, no-hard-tabs)
Hard tabs
266-266: Column: 1 (MD010, no-hard-tabs)
Hard tabs
267-267: Column: 1 (MD010, no-hard-tabs)
Hard tabs
268-268: Column: 1 (MD010, no-hard-tabs)
Hard tabs
269-269: Column: 1 (MD010, no-hard-tabs)
Hard tabs
270-270: Column: 1 (MD010, no-hard-tabs)
Hard tabs
282-282: Column: 1 (MD010, no-hard-tabs)
Hard tabs
283-283: Column: 1 (MD010, no-hard-tabs)
Hard tabs
284-284: Column: 1 (MD010, no-hard-tabs)
Hard tabs
292-292: Column: 1 (MD010, no-hard-tabs)
Hard tabs
293-293: Column: 1 (MD010, no-hard-tabs)
Hard tabs
294-294: Column: 1 (MD010, no-hard-tabs)
Hard tabs
304-304: Column: 1 (MD010, no-hard-tabs)
Hard tabs
306-306: Column: 1 (MD010, no-hard-tabs)
Hard tabs
307-307: Column: 1 (MD010, no-hard-tabs)
Hard tabs
308-308: Column: 1 (MD010, no-hard-tabs)
Hard tabs
309-309: Column: 1 (MD010, no-hard-tabs)
Hard tabs
402-402: Column: 1 (MD010, no-hard-tabs)
Hard tabs
404-404: Column: 1 (MD010, no-hard-tabs)
Hard tabs
412-412: Column: 1 (MD010, no-hard-tabs)
Hard tabs
414-414: Column: 1 (MD010, no-hard-tabs)
Hard tabs
415-415: Column: 1 (MD010, no-hard-tabs)
Hard tabs
416-416: Column: 1 (MD010, no-hard-tabs)
Hard tabs
432-432: Column: 1 (MD010, no-hard-tabs)
Hard tabs
434-434: Column: 1 (MD010, no-hard-tabs)
Hard tabs
435-435: Column: 1 (MD010, no-hard-tabs)
Hard tabs
436-436: Column: 1 (MD010, no-hard-tabs)
Hard tabs
437-437: Column: 1 (MD010, no-hard-tabs)
Hard tabs
438-438: Column: 1 (MD010, no-hard-tabs)
Hard tabs
450-450: Column: 1 (MD010, no-hard-tabs)
Hard tabs
451-451: Column: 1 (MD010, no-hard-tabs)
Hard tabs
452-452: Column: 1 (MD010, no-hard-tabs)
Hard tabs
453-453: Column: 1 (MD010, no-hard-tabs)
Hard tabs
454-454: Column: 1 (MD010, no-hard-tabs)
Hard tabs
455-455: Column: 1 (MD010, no-hard-tabs)
Hard tabs
456-456: Column: 1 (MD010, no-hard-tabs)
Hard tabs
457-457: Column: 1 (MD010, no-hard-tabs)
Hard tabs
458-458: Column: 1 (MD010, no-hard-tabs)
Hard tabs
459-459: Column: 1 (MD010, no-hard-tabs)
Hard tabs
460-460: Column: 1 (MD010, no-hard-tabs)
Hard tabs
461-461: Column: 1 (MD010, no-hard-tabs)
Hard tabs
462-462: Column: 1 (MD010, no-hard-tabs)
Hard tabs
463-463: Column: 1 (MD010, no-hard-tabs)
Hard tabs
464-464: Column: 1 (MD010, no-hard-tabs)
Hard tabs
465-465: Column: 1 (MD010, no-hard-tabs)
Hard tabs
479-479: Column: 1 (MD010, no-hard-tabs)
Hard tabs
| @@ -253,7 +253,7 @@ if we add username to the URL like this `/?framework=svelte&isCool=true&username | |||
|
|
|||
| ### Encoding and Decoding | |||
|
|
|||
| The parameter passed to `queryParameters` can aslo be used to specify the encoding and decoding just like the `queryParam` method. | |||
| The parameter passed to `queryParameters` can also be used to specify the encoding and decoding just like the `queryParam` method. | |||
There was a problem hiding this comment.
Correct usage of commas in complex sentences.
- The parameter passed to `queryParameters` can also be used to specify the encoding and decoding just like the `queryParam` method.
+ The parameter passed to `queryParameters` can also be used to specify the encoding and decoding, just like the `queryParam` method.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The parameter passed to `queryParameters` can also be used to specify the encoding and decoding just like the `queryParam` method. | |
| The parameter passed to `queryParameters` can also be used to specify the encoding and decoding, just like the `queryParam` method. |
Tools
LanguageTool
[uncategorized] ~256-~256: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA)
Context: ...lso be used to specify the encoding and decoding just like thequeryParammethod. ```...
Summary by CodeRabbit