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: Miscellaneous fixes #2259

Merged
merged 7 commits into from
Aug 30, 2023
Merged

docs: Miscellaneous fixes #2259

merged 7 commits into from
Aug 30, 2023

Conversation

sean-donoghue
Copy link
Contributor

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

  • Miscellaneous typo and punctuation fixes.
  • Adjusted emphasized lines of example code blocks in the tutorials; many were misaligned most likely due to changes to the underlying .py files which were not reflected in the docs.
  • Modified descriptions of SQLAlchemy repository functions in the docs to be more consistent with each other.
  • Updated links to external Real Python articles to use hyperlinked article names instead of raw URLs.
  • No code changes, pre-commit was run before pushing.

Close Issue(s)

  • None

Signed-off-by: Sean Donoghue <sean.donoghue@pm.me>
Signed-off-by: Sean Donoghue <sean.donoghue@pm.me>
Signed-off-by: Sean Donoghue <sean.donoghue@pm.me>
Signed-off-by: Sean Donoghue <sean.donoghue@pm.me>
Signed-off-by: Sean Donoghue <sean.donoghue@pm.me>
@cofin
Copy link
Member

cofin commented Aug 30, 2023

@sean-donoghue you are a true hero!

@cofin
Copy link
Member

cofin commented Aug 30, 2023

@all-contributors add @sean-donoghue for docs

@allcontributors
Copy link
Contributor

@cofin

I've put up a pull request to add @sean-donoghue! 🎉

@cofin
Copy link
Member

cofin commented Aug 30, 2023

@sean-donoghue can you run poetry run pre-commit run --all-files and commit the changes?

Copy link
Member

@cofin cofin left a comment

Choose a reason for hiding this comment

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

LGTM.

This REALLY needed to be done. Thanks for taking the time on this.

@cofin cofin enabled auto-merge (squash) August 30, 2023 00:50
Signed-off-by: Sean Donoghue <sean.donoghue@pm.me>
auto-merge was automatically disabled August 30, 2023 08:45

Head branch was pushed to by a user without write access

@sean-donoghue
Copy link
Contributor Author

@sean-donoghue can you run poetry run pre-commit run --all-files and commit the changes?

Oops, had to clear my Poetry cache for pre-commit to pick up the changes. Done!

@github-actions
Copy link

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

@cofin cofin merged commit c951d63 into litestar-org:main Aug 30, 2023
17 checks passed
@sean-donoghue sean-donoghue deleted the docs-fix branch August 31, 2023 20:35
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

2 participants