Skip to content

Refactor path parameter usage in documentation #6042

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.

Sign up for GitHub

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

Merged
birkskyum merged 1 commit into from
Dec 10, 2025
Merged

Refactor path parameter usage in documentation #6042

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/router/framework/solid/guide/path-params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ replace:
'{ fileName } = Route.useParams()': 'params = Route.useParams',
'{ userId } = Route.useParams()': 'params = Route.useParams',
'{ _splat } = Route.useParams()': 'params = Route.useParams',
'{postId}': '{params.postId()}',
'{userId}': '{params.userId()}',
'{fileName}': '{params.userId()}',
'{_splat}': '{params._splat()}',
'{postId}': '{params().postId}',
'{userId}': '{params().userId}',
'{fileName}': '{params().userId}',
'{_splat}': '{params()._splat}',
Comment on lines +10 to +13
Copy link
Contributor

@coderabbitai coderabbitai bot Dec 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Fix incorrect template mapping on line 12.

Line 12 contains a copy-paste error: '{fileName}': '{params().userId}' should use params().fileName instead of params().userId. This will cause documentation examples using fileName parameters to render incorrect code samples.

Apply this diff to fix the mapping:

  {
    'react-router': 'solid-router',
    '{ postId } = Route.useParams()': 'params = Route.useParams',
    '{ fileName } = Route.useParams()': 'params = Route.useParams',
    '{ userId } = Route.useParams()': 'params = Route.useParams',
    '{ _splat } = Route.useParams()': 'params = Route.useParams',
    '{postId}': '{params().postId}',
    '{userId}': '{params().userId}',
-   '{fileName}': '{params().userId}',
+   '{fileName}': '{params().fileName}',
    '{_splat}': '{params()._splat}',
  }

The other mappings on lines 10, 11, and 13 correctly update the Solid signal accessor syntax from the incorrect params.propName() pattern to the correct params().propName pattern.

📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
'{postId}': '{params().postId}',
'{userId}': '{params().userId}',
'{fileName}': '{params().userId}',
'{_splat}': '{params()._splat}',
'{postId}': '{params().postId}',
'{userId}': '{params().userId}',
'{fileName}': '{params().fileName}',
'{_splat}': '{params()._splat}',
🤖 Prompt for AI Agents 
In docs/router/framework/solid/guide/path-params.md around lines 10 to 13 there
is a copy-paste error mapping '{fileName}': '{params().userId}' — change it to
use the correct Solid signal accessor for fileName by mapping '{fileName}' to
'{params().fileName}' so the example shows params().fileName rather than
params().userId; leave the other mappings as-is.

Copy link
Contributor

@schiller-manuel schiller-manuel Dec 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

@galarus can you please apply this fix?

Copy link
Contributor

@coderabbitai coderabbitai bot Dec 8, 2025

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

}
---
Loading