Skip to content

Conversation

@henadzit
Copy link
Contributor

@henadzit henadzit commented Jun 5, 2025

Description

  • Simplify the "Why was Tortoise ORM built?" section
  • Improve the setup and router pages
  • Remove changelog from search since it ranks above all pages but is not very useful

Motivation and Context

...

How Has This Been Tested?

make docs

Checklist:

  • My code follows the code style of this project.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.
  • I have added the changelog accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@henadzit henadzit requested a review from Copilot June 5, 2025 09:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR improves and simplifies the documentation for Tortoise ORM by clarifying language and updating code examples where needed. Key changes include:

  • Refining the "Initialize Your Application" section in docs/setup.rst with updated code examples and clearer explanations.
  • Enhancing wording and formatting in docs/router.rst, docs/index.rst, docs/databases.rst, and README.rst to improve consistency and clarity.
  • Adding a no-search directive in CHANGELOG.rst to optimize documentation search behavior.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
docs/setup.rst Updated initialization instructions and code example changes.
docs/router.rst Clarified router configuration and adjusted instructional text.
docs/index.rst Simplified overview of Tortoise ORM purpose and benchmarks.
docs/databases.rst Streamlined database URL documentation.
README.rst Matched introductory text changes with docs/index.rst.
CHANGELOG.rst Added a no-search directive to the changelog.
Comments suppressed due to low confidence (1)

docs/setup.rst:24

  • The comment above this code still refers to the app name as 'models', but the code uses 'app' as the key. Please update the comment to reflect the new naming for clarity.
modules={'app': ['app.models']}

@codspeed-hq
Copy link

codspeed-hq bot commented Jun 5, 2025

CodSpeed Performance Report

Merging #1962 will not alter performance

Comparing henadzit:chore/improve-docs (8a0b2f8) with develop (8ee43fa)

Summary

✅ 16 untouched benchmarks

@henadzit henadzit merged commit 58a2321 into tortoise:develop Jun 5, 2025
9 checks passed
@coveralls
Copy link

Pull Request Test Coverage Report for Build 15463537917

Warning: This coverage report may be inaccurate.

This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.668%

Totals Coverage Status
Change from base Build 15429545687: 0.0%
Covered Lines: 6674
Relevant Lines: 7263

💛 - Coveralls

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.

3 participants