Skip to content

docs: Replace contrib with plugins in example code#4094

Merged
cofin merged 2 commits intolitestar-org:mainfrom
eandersons:Replace-contrib-with-plugins-in-example-code
Apr 13, 2025
Merged

docs: Replace contrib with plugins in example code#4094
cofin merged 2 commits intolitestar-org:mainfrom
eandersons:Replace-contrib-with-plugins-in-example-code

Conversation

@eandersons
Copy link
Copy Markdown
Contributor

By submitting this pull request, I agree to:

Description

Changes in example code were made to use litestar.plugins.sqlalchemy instead of litestar.contrib.sqlalchemy as the latter is being depreciated.
Documentation files where the changed files were referenced were updated as well to adjust the referenced lines because:

  • amount of lines in the import section were changed in some referenced files that were updated;
  • they already were off.

Additionally imports and other relevant parts were included in code example blocks so it could be easily seen what is imported from where.

Closes

Not applicable.

@eandersons eandersons requested review from a team as code owners April 8, 2025 13:21
@github-actions github-actions bot added area/docs This PR involves changes to the documentation size: medium type/docs pr/external Triage Required 🏥 This requires triage labels Apr 8, 2025
@eandersons eandersons marked this pull request as draft April 8, 2025 13:45
@eandersons eandersons force-pushed the Replace-contrib-with-plugins-in-example-code branch from 690198b to d5dba1d Compare April 8, 2025 13:53
@eandersons eandersons marked this pull request as ready for review April 9, 2025 09:40
Copy link
Copy Markdown
Contributor

@euri10 euri10 left a comment

Choose a reason for hiding this comment

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

this lgtm but I dont use sqlalchemy so hard to see if there would be some issues.

@provinzkraut
Copy link
Copy Markdown
Member

@cofin

Changes in example code were made to use `litestar.plugins.sqlalchemy`
instead of `litestar.contrib.sqlalchemy` as the latter is being
depreciated.
Referenced lines in code examples were adjusted because:

- lines count in Python code example files changed because of changes
  made to use `litestar.plugins.sqlalchemy` instead of
  `litestar.contrib.sqlalchemy` as the latter is being depreciated;
- they were already off before aforementioned changes.
@cofin cofin force-pushed the Replace-contrib-with-plugins-in-example-code branch from d5dba1d to 66d55d5 Compare April 13, 2025 17:44
@cofin cofin enabled auto-merge (squash) April 13, 2025 17:45
@cofin cofin merged commit 3820c15 into litestar-org:main Apr 13, 2025
28 checks passed
@github-actions
Copy link
Copy Markdown

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

@eandersons eandersons deleted the Replace-contrib-with-plugins-in-example-code branch April 14, 2025 12:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs This PR involves changes to the documentation pr/external pr/internal size: medium Triage Required 🏥 This requires triage type/docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants