Skip to content

Commit 9461fd8

Browse files
Kataev Deniszzzeek
Kataev Denis
authored andcommitted
Repair formatting throughout documentation
1. Section decorators to [one style](http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#sections): without inset at both side and with same length as text. 2. Fix broken [reference](http://docs.sqlalchemy.org/en/latest/core/type_basics.html#generic-types). 3. Convert tabs to space in some small files. 4. Some python code snippets have python+sql syntax hint. Change-Id: I39a7a41ef0b0591c6bf1e610748e2b5c19fc5379 Pull-request: #361 (cherry picked from commit 42b6ef8)
1 parent 8cce3be commit 9461fd8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+293
-293
lines changed

doc/build/changelog/changelog_01.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.1 Changelog
4-
==============
4+
=============
55

66

77
.. changelog::

doc/build/changelog/changelog_02.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.2 Changelog
4-
==============
4+
=============
55

66

77
.. changelog::

doc/build/changelog/changelog_03.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.3 Changelog
4-
==============
4+
=============
55

66

77
.. changelog::

doc/build/changelog/changelog_04.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.4 Changelog
4-
==============
4+
=============
55

66

77
.. changelog::

doc/build/changelog/changelog_05.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.5 Changelog
4-
==============
4+
=============
55

66

77
.. changelog::

doc/build/changelog/changelog_06.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.6 Changelog
4-
==============
4+
=============
55

66

77
.. changelog::

doc/build/changelog/changelog_07.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.7 Changelog
4-
==============
4+
=============
55

66
.. changelog::
77
:version: 0.7.11

doc/build/changelog/changelog_08.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.8 Changelog
4-
==============
4+
=============
55

66
.. changelog_imports::
77

doc/build/changelog/changelog_09.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
==============
2+
=============
33
0.9 Changelog
4-
==============
4+
=============
55

66
.. changelog_imports::
77

doc/build/changelog/changelog_10.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22

3-
==============
3+
=============
44
1.0 Changelog
5-
==============
5+
=============
66

77
.. changelog_imports::
88

doc/build/changelog/changelog_11.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22

3-
==============
3+
=============
44
1.1 Changelog
5-
==============
5+
=============
66

77
.. changelog_imports::
88

doc/build/changelog/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ SQLAlchemy changelogs and migration guides are now integrated
77
within the main documentation.
88

99
Current Migration Guide
10-
------------------------
10+
-----------------------
1111

1212
.. toctree::
1313
:titlesonly:

doc/build/changelog/migration_06.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==============================
1+
=============================
22
What's New in SQLAlchemy 0.6?
3-
==============================
3+
=============================
44

55
.. admonition:: About this Document
66

doc/build/changelog/migration_07.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==============================
1+
=============================
22
What's New in SQLAlchemy 0.7?
3-
==============================
3+
=============================
44

55
.. admonition:: About this Document
66

doc/build/changelog/migration_08.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==============================
1+
=============================
22
What's New in SQLAlchemy 0.8?
3-
==============================
3+
=============================
44

55
.. admonition:: About this Document
66

@@ -527,7 +527,7 @@ the :class:`.Table` to which ``User`` is mapped.
527527
:ticket:`2245`
528528

529529
Query.update() supports UPDATE..FROM
530-
-------------------------------------
530+
------------------------------------
531531

532532
The new UPDATE..FROM mechanics work in query.update().
533533
Below, we emit an UPDATE against ``SomeEntity``, adding
@@ -576,7 +576,7 @@ that were not flushed in the current transaction.
576576
:ticket:`2452`
577577

578578
Caching Example now uses dogpile.cache
579-
---------------------------------------
579+
--------------------------------------
580580

581581
The caching example now uses `dogpile.cache <https://dogpilecache.readthedocs.io/>`_.
582582
Dogpile.cache is a rewrite of the caching portion
@@ -607,7 +607,7 @@ this change is needed as illustrated in the Beaker example::
607607
:ticket:`2589`
608608

609609
New Core Features
610-
==================
610+
=================
611611

612612
Fully extensible, type-level operator support in Core
613613
-----------------------------------------------------
@@ -686,7 +686,7 @@ as more string, integer and date operators.
686686
.. _feature_2623:
687687

688688
Multiple-VALUES support for Insert
689-
-----------------------------------
689+
----------------------------------
690690

691691
The :meth:`.Insert.values` method now supports a list of dictionaries,
692692
which will render a multi-VALUES statement such as
@@ -708,7 +708,7 @@ remains unchanged::
708708
:ticket:`2623`
709709

710710
Type Expressions
711-
-----------------
711+
----------------
712712

713713
SQL expressions can now be associated with types. Historically,
714714
:class:`.TypeEngine` has always allowed Python-side functions which
@@ -753,7 +753,7 @@ to embed PostGIS expressions inline in SQL based on type rules.
753753
:ticket:`1534`
754754

755755
Core Inspection System
756-
-----------------------
756+
----------------------
757757

758758
The :func:`.inspect` function introduced in :ref:`feature_orminspection_08`
759759
also applies to the core. Applied to an :class:`.Engine` it produces
@@ -1241,7 +1241,7 @@ the previous behavior.
12411241
:ticket:`2664`
12421242

12431243
Repaired the Event Targeting of :class:`.InstrumentationEvents`
1244-
----------------------------------------------------------------
1244+
---------------------------------------------------------------
12451245

12461246
The :class:`.InstrumentationEvents` series of event targets have
12471247
documented that the events will only be fired off according to

doc/build/changelog/migration_10.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
==============================
1+
=============================
22
What's New in SQLAlchemy 1.0?
3-
==============================
3+
=============================
44

55
.. admonition:: About this Document
66

@@ -41,7 +41,7 @@ to proceed at speeds that rival direct use of the Core.
4141
:ticket:`3100`
4242

4343
New Performance Example Suite
44-
------------------------------
44+
-----------------------------
4545

4646
Inspired by the benchmarking done for the :ref:`bulk_operations` feature
4747
as well as for the :ref:`faq_how_to_profile` section of the FAQ, a new
@@ -94,7 +94,7 @@ once, a query as a pre-compiled unit begins to be feasible::
9494
.. _feature_3150:
9595

9696
Improvements to declarative mixins, ``@declared_attr`` and related features
97-
----------------------------------------------------------------------------
97+
---------------------------------------------------------------------------
9898

9999
The declarative system in conjunction with :class:`.declared_attr` has been
100100
overhauled to support new capabilities.
@@ -322,7 +322,7 @@ object totally smokes both namedtuple and KeyedTuple::
322322
.. _feature_slots:
323323

324324
Significant Improvements in Structural Memory Use
325-
--------------------------------------------------
325+
-------------------------------------------------
326326

327327
Structural memory use has been improved via much more significant use
328328
of ``__slots__`` for many internal objects. This optimization is
@@ -353,7 +353,7 @@ well as weakrefs, within a basic import of "nova.db.sqlalchemy.models"::
353353
.. _feature_updatemany:
354354

355355
UPDATE statements are now batched with executemany() in a flush
356-
----------------------------------------------------------------
356+
---------------------------------------------------------------
357357

358358
UPDATE statements can now be batched within an ORM flush
359359
into more performant executemany() call, similarly to how INSERT
@@ -418,7 +418,7 @@ of inheritance-oriented scenarios, including:
418418
.. _bug_3227:
419419

420420
Session.get_bind() will receive the Mapper in all relevant Query cases
421-
-----------------------------------------------------------------------
421+
----------------------------------------------------------------------
422422

423423
A series of issues were repaired where the :meth:`.Session.get_bind`
424424
would not receive the primary :class:`.Mapper` of the :class:`.Query`,
@@ -501,7 +501,7 @@ as remaining ORM constructs such as :func:`.orm.synonym`.
501501
.. _bug_3188:
502502

503503
ColumnProperty constructs work a lot better with aliases, order_by
504-
-------------------------------------------------------------------
504+
------------------------------------------------------------------
505505

506506
A variety of issues regarding :func:`.column_property` have been fixed,
507507
most specifically with regards to the :func:`.aliased` construct as well
@@ -583,7 +583,7 @@ New Features and Improvements - Core
583583
.. _feature_3034:
584584

585585
Select/Query LIMIT / OFFSET may be specified as an arbitrary SQL expression
586-
----------------------------------------------------------------------------
586+
---------------------------------------------------------------------------
587587

588588
The :meth:`.Select.limit` and :meth:`.Select.offset` methods now accept
589589
any SQL expression, in addition to integer values, as arguments. The ORM
@@ -826,7 +826,7 @@ the :class:`.Constraint` is constructed::
826826
.. _feature_insert_from_select_defaults:
827827

828828
INSERT FROM SELECT now includes Python and SQL-expression defaults
829-
-------------------------------------------------------------------
829+
------------------------------------------------------------------
830830

831831
:meth:`.Insert.from_select` now includes Python and SQL-expression defaults if
832832
otherwise unspecified; the limitation where non-server column defaults
@@ -1354,7 +1354,7 @@ joined loader options can still be used::
13541354
.. _bug_3233:
13551355

13561356
Changes and fixes in handling of duplicate join targets
1357-
--------------------------------------------------------
1357+
-------------------------------------------------------
13581358

13591359
Changes here encompass bugs where an unexpected and inconsistent
13601360
behavior would occur in some scenarios when joining to an entity
@@ -2155,7 +2155,7 @@ state.
21552155
.. _feature_3084:
21562156

21572157
MetaData.sorted_tables accessor is "deterministic"
2158-
-----------------------------------------------------
2158+
--------------------------------------------------
21592159

21602160
The sorting of tables resulting from the :attr:`.MetaData.sorted_tables`
21612161
accessor is "deterministic"; the ordering should be the same in all cases
@@ -2264,7 +2264,7 @@ flag::
22642264
:ticket:`3319`
22652265

22662266
New PostgreSQL Table options
2267-
-----------------------------
2267+
----------------------------
22682268

22692269
Added support for PG table options TABLESPACE, ON COMMIT,
22702270
WITH(OUT) OIDS, and INHERITS, when rendering DDL via
@@ -2398,14 +2398,14 @@ by PostgreSQL as of 9.4. SQLAlchemy allows this using
23982398
:class:`.FunctionFilter`
23992399

24002400
PG8000 dialect supports client side encoding
2401-
---------------------------------------------
2401+
--------------------------------------------
24022402

24032403
The :paramref:`.create_engine.encoding` parameter is now honored
24042404
by the pg8000 dialect, using on connect handler which
24052405
emits ``SET CLIENT_ENCODING`` matching the selected encoding.
24062406

24072407
PG8000 native JSONB support
2408-
--------------------------------------
2408+
---------------------------
24092409

24102410
Support for PG8000 versions greater than 1.10.1 has been added, where
24112411
JSONB is supported natively.
@@ -2421,12 +2421,12 @@ Support for the pypy psycopg2cffi dialect is added.
24212421
:mod:`sqlalchemy.dialects.postgresql.psycopg2cffi`
24222422

24232423
Dialect Improvements and Changes - MySQL
2424-
=============================================
2424+
========================================
24252425

24262426
.. _change_3155:
24272427

24282428
MySQL TIMESTAMP Type now renders NULL / NOT NULL in all cases
2429-
--------------------------------------------------------------
2429+
-------------------------------------------------------------
24302430

24312431
The MySQL dialect has always worked around MySQL's implicit NOT NULL
24322432
default associated with TIMESTAMP columns by emitting NULL for
@@ -2449,7 +2449,7 @@ columns.
24492449
.. _change_3283:
24502450

24512451
MySQL SET Type Overhauled to support empty sets, unicode, blank value handling
2452-
-------------------------------------------------------------------------------
2452+
------------------------------------------------------------------------------
24532453

24542454
The :class:`.mysql.SET` type historically not included a system of handling
24552455
blank sets and empty values separately; as different drivers had different
@@ -2582,7 +2582,7 @@ and is generally in decent working order, if someone wants to pick up
25822582
on polishing it.
25832583

25842584
Dialect Improvements and Changes - SQLite
2585-
=============================================
2585+
=========================================
25862586

25872587
SQLite named and unnamed UNIQUE and FOREIGN KEY constraints will inspect and reflect
25882588
-------------------------------------------------------------------------------------
@@ -2632,7 +2632,7 @@ to control the behavior completely, based on deprecation guidelines from
26322632
Microsoft. See :ref:`mssql_large_type_deprecation` for details.
26332633

26342634
Dialect Improvements and Changes - Oracle
2635-
=============================================
2635+
=========================================
26362636

26372637
.. _change_3220:
26382638

@@ -2653,7 +2653,7 @@ CTE support has been fixed up for Oracle, and there is also a new feature
26532653
:ticket:`3220`
26542654

26552655
New Oracle Keywords for DDL
2656-
-----------------------------
2656+
---------------------------
26572657

26582658
Keywords such as COMPRESS, ON COMMIT, BITMAP:
26592659

0 commit comments

Comments
 (0)