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

docs: update ArticleQuery type in routing-params.md #8895

Merged
merged 1 commit into from
Jul 13, 2023
Merged

docs: update ArticleQuery type in routing-params.md #8895

merged 1 commit into from
Jul 13, 2023

Conversation

ekafyi
Copy link
Contributor

@ekafyi ekafyi commented Jul 13, 2023

Closes #8889

This PR replaces ArticleQuery type with FindArticleQuery, which is the generated code when running yarn rw g cell Article (any singular-form name).

To be fair, it does not matter whether ArticleQuery or FindArticleQuery is used (ie. will not cause error either way), except when user copy-pastes from the following block and does not modify their auto-generated code accordingly.

CleanShot 2023-07-13 at 7 15 23

Thus it may be better to update the tutorial code to reflect the auto-generated code.

Copy link
Contributor

@jtoar jtoar left a comment

Choose a reason for hiding this comment

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

Thanks @ekafyi!

@jtoar jtoar added the release:docs This PR only updates docs label Jul 13, 2023
@jtoar jtoar added this to the next-release milestone Jul 13, 2023
@jtoar jtoar merged commit edd83db into redwoodjs:main Jul 13, 2023
@ekafyi ekafyi deleted the patch-1 branch July 14, 2023 04:07
@jtoar jtoar modified the milestones: next-release, v6.0.0 Jul 17, 2023
jtoar pushed a commit that referenced this pull request Jul 17, 2023
Closes #8889

This PR replaces `ArticleQuery` type with `FindArticleQuery`, which is
the generated code when running `yarn rw g cell Article` (any
singular-form name).

To be fair, it does not matter whether `ArticleQuery` or
`FindArticleQuery` is used (ie. will not cause error either way),
_except_ when user copy-pastes from the following block and does not
modify their auto-generated code accordingly.

![CleanShot 2023-07-13 at 7 15
23](https://github.com/redwoodjs/redwood/assets/6597211/627effce-2b80-4eea-bbe5-0313137571a6)

Thus it may be better to update the tutorial code to reflect the
auto-generated code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release:docs This PR only updates docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: Tutorial Chapter 2 on routing params ArticleQuery type
2 participants