From: hashAbhiBytes <anandabhimanyuyo@gmail.com>
Date: Thu, 12 Dec 2024 21:17:39 +0000 (-0500)
Subject: Updated SQLAlchemy documentation in index.rst
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=b9a5ae44bd60fc807eae4c4fa195af96ce347d9e;p=thirdparty%2Fsqlalchemy%2Fsqlalchemy.git

Updated SQLAlchemy documentation in index.rst

Closes: #12132
Pull-request: https://github.com/sqlalchemy/sqlalchemy/pull/12132
Pull-request-sha: 4a11a6548d812b1f61739397a3ccaa331f76a494

Change-Id: Icc03f12470b288aabf9099c8c4e2220ce62efcf0
---

diff --git a/doc/build/index.rst b/doc/build/index.rst
index 4a0065226a..6846a00e89 100644
--- a/doc/build/index.rst
+++ b/doc/build/index.rst
@@ -18,9 +18,11 @@ SQLAlchemy Documentation
 
     New to SQLAlchemy?   Start here:
 
-    * **For Python Beginners:** :ref:`Installation Guide <installation>` - basic guidance on installing with pip and similar
+    * **For Python Beginners:** :ref:`Installation Guide <installation>` - Basic
+      guidance on installing with pip and similar tools
 
-    * **For Python Veterans:** :doc:`SQLAlchemy Overview <intro>` - brief architectural overview
+    * **For Python Veterans:** :doc:`SQLAlchemy Overview <intro>` - A brief
+      architectural overview of SQLAlchemy
 
 .. container:: left_right_container
 
@@ -37,10 +39,11 @@ SQLAlchemy Documentation
     :doc:`/tutorial/index`, which covers everything an Alchemist needs
     to know when using the ORM or just Core.
 
-    * **For a quick glance:** :doc:`/orm/quickstart` - a glimpse at what working with the ORM looks like
-
-    * **For all users:** :doc:`/tutorial/index` - In depth tutorial for Core and ORM
+    * **For a quick glance:** :doc:`/orm/quickstart` - A brief overview of
+      what working with the ORM looks like
 
+    * **For all users:** :doc:`/tutorial/index` - In-depth tutorial for
+      both Core and ORM usage
 
 .. container:: left_right_container
 
@@ -52,21 +55,26 @@ SQLAlchemy Documentation
 
   .. container::
 
-    Users coming SQLAlchemy version 2.0 will want to read:
+    Users upgrading to SQLAlchemy version 2.0 will want to read:
 
-    * :doc:`What's New in SQLAlchemy 2.1? <changelog/migration_21>` - New features and behaviors in version 2.1
+    * :doc:`What's New in SQLAlchemy 2.1? <changelog/migration_21>` - New
+      features and behaviors in version 2.1
 
-    Users transitioning from 1.x versions of SQLAlchemy, such as version 1.4, will want to
-    transition to version 2.0 overall before making any additional changes needed for
-    the much smaller transition from 2.0 to 2.1.   Key documentation for the 1.x to 2.x
-    transition:
+    Users transitioning from version 1.x of SQLAlchemy (e.g., version 1.4)
+    should first transition to version 2.0 before making any additional
+    changes needed for the smaller transition from 2.0 to 2.1.
+    Key documentation for the 1.x to 2.x transition:
 
-    * :doc:`Migrating to SQLAlchemy 2.0 <changelog/migration_20>` - Complete background on migrating from 1.3 or 1.4 to 2.0
-    * :doc:`What's New in SQLAlchemy 2.0? <changelog/whatsnew_20>` - New 2.0 features and behaviors beyond the 1.x migration
+    * :doc:`Migrating to SQLAlchemy 2.0 <changelog/migration_20>` - Complete
+      background on migrating from 1.3 or 1.4 to 2.0
+    * :doc:`What's New in SQLAlchemy 2.0? <changelog/whatsnew_20>` - New
+      features and behaviors introduced in version 2.0 beyond the 1.x
+      migration
 
-    An index of all changelogs and migration documentation is at:
+    An index of all changelogs and migration documentation is available at:
 
-    * :doc:`Changelog catalog <changelog/index>` - Detailed changelogs for all SQLAlchemy Versions
+    * :doc:`Changelog catalog <changelog/index>` - Detailed
+      changelogs for all SQLAlchemy Versions
 
 
 .. container:: left_right_container
@@ -154,8 +162,10 @@ SQLAlchemy Documentation
 
     .. container::
 
-      The **dialect** is the system SQLAlchemy uses to communicate with various types of DBAPIs and databases.
-      This section describes notes, options, and usage patterns regarding individual dialects.
+      The **dialect** is the system SQLAlchemy uses to communicate with
+      various types of DBAPIs and databases.
+      This section describes notes, options, and usage patterns regarding
+      individual dialects.
 
       :doc:`PostgreSQL <dialects/postgresql>` |
       :doc:`MySQL and MariaDB <dialects/mysql>` |
@@ -175,8 +185,12 @@ SQLAlchemy Documentation
 
   .. container::
 
-    * :doc:`Frequently Asked Questions <faq/index>` - A collection of common problems and solutions
-    * :doc:`Glossary <glossary>` - Terms used in SQLAlchemy's documentation
-    * :doc:`Error Message Guide <errors>` - Explanations of many SQLAlchemy Errors
-    * :doc:`Complete table of of contents <contents>`
-    * :ref:`Index <genindex>`
+    * :doc:`Frequently Asked Questions <faq/index>` - A collection of common
+      problems and solutions
+    * :doc:`Glossary <glossary>` - Definitions of terms used in SQLAlchemy
+      documentation
+    * :doc:`Error Message Guide <errors>` - Explanations of many SQLAlchemy
+      errors
+    * :doc:`Complete table of of contents <contents>` - Full list of available
+      documentation
+    * :ref:`Index <genindex>` - Index for easy lookup of documentation topics
\ No newline at end of file