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(DTO): Replace PartialDataDTO with DTOData #2194

Merged
merged 2 commits into from
Aug 22, 2023

Conversation

ddxv
Copy link
Contributor

@ddxv ddxv commented Aug 22, 2023

…itestar.dev/latest/tutorials/dto-tutorial/09-updating.html#patch-handlers

Pull Request Checklist

  • New code has 100% test coverage
  • (If applicable) The prose documentation has been updated to reflect the changes introduced by this PR
  • (If applicable) The reference documentation has been updated to reflect the changes introduced by this PR

Description

This PR fixes an apparent typo in the Extended Example on the index.rst homepage.

When running the hello world Extended Example, I was unable to proceed due to this error:
litestar.exceptions.dto_exceptions.InvalidAnnotationException: DTO narrowed with '<class 'my_app.models.User'>', handler type is '<class 'my_app.models.PartialUserDTO'>'

Discord Channel User Alc pointed me in the direction of a fix based on:
https://litestar.dev/latest/tutorials/dto-tutorial/09-updating.html#patch-handlers

Close Issue(s)

@ddxv ddxv requested review from JacobCoffee, provinzkraut and a team as code owners August 22, 2023 07:31
@ddxv ddxv changed the title Replace PartialDataDTO with DTOData. Based on example: https://docs.l… fix: Replace PartialDataDTO with DTOData Aug 22, 2023
@Alc-Alc Alc-Alc changed the title fix: Replace PartialDataDTO with DTOData docs(DTO): Replace PartialDataDTO with DTOData Aug 22, 2023
Copy link
Contributor

@Alc-Alc Alc-Alc left a comment

Choose a reason for hiding this comment

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

Thanks, just a minor nitpick with the import statement 🙂

docs/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor Author

@ddxv ddxv left a comment

Choose a reason for hiding this comment

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

Fixed DataDTO to DataDTO[User]

docs/index.rst Outdated Show resolved Hide resolved
@github-actions
Copy link

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/2194

@provinzkraut provinzkraut merged commit 91a7990 into litestar-org:main Aug 22, 2023
17 checks passed
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.

None yet

3 participants