]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commit
standardizing docs #6821
authorjonathan vanasco <jonathan@2xlp.com>
Mon, 23 Aug 2021 20:25:21 +0000 (16:25 -0400)
committerjonathan vanasco <jonathan@2xlp.com>
Mon, 23 Aug 2021 20:25:21 +0000 (16:25 -0400)
commit369edbbd674c2dcdc121072a20b3f9d259f9ee91
tree92c8f145ce641e8170a48e900c54e2eac22be42d
parent207ec35c2e175f5fcf68e886d5e61a0678c2d6fc
standardizing docs #6821
(redo of 2999/I5609025feee8cfdecc09b55bfbf1bd13fa2e6602)

This PR is designed to bring more clarity within the docs by renaming object
instances that may be consfusingly similar to class, method, and attribute names.

For example, instances of the class `MetaData` are available on some  objects as
`.metadata` property, and had appeared within the docs as both `meta` and
`metadata` which has confused some users in the past. By this PR, the docs now
utilize the following naming convention:

* MetaData - SQLAlchemy class
* .metadata - SQLAlchemy API attributes
* metadata_obj - developer instantiated metadata objects or references

Detailed Changes:

* standardized `meta` and `metadata` instances to `metadata_obj`. note: the docs were evenly split between 'meta' and 'metadata'.
* standardized 'cursor' to 'cursor_obj' to avoid confusion with the method.
* standardized a 'scalar_subquery = ' to 'scalar_subq' to avoid confusion with the method.
* standardized a 'cte = ' to 'cte_obj' to avoid confusion with the method

Change-Id: I79c98aee16c5fc6649289b2dd7d6dfc368222fb4
26 files changed:
doc/build/changelog/migration_13.rst
doc/build/changelog/migration_20.rst
doc/build/core/connections.rst
doc/build/core/constraints.rst
doc/build/core/custom_types.rst
doc/build/core/defaults.rst
doc/build/core/engines.rst
doc/build/core/metadata.rst
doc/build/core/operators.rst
doc/build/core/pooling.rst
doc/build/core/reflection.rst
doc/build/core/tutorial.rst
doc/build/errors.rst
doc/build/faq/connections.rst
doc/build/faq/metadata_schema.rst
doc/build/orm/declarative_config.rst
doc/build/orm/declarative_tables.rst
doc/build/orm/inheritance.rst
doc/build/orm/join_conditions.rst
doc/build/orm/mapping_styles.rst
doc/build/orm/nonstandard_mappings.rst
doc/build/orm/queryguide.rst
doc/build/orm/tutorial.rst
doc/build/tutorial/data_insert.rst
doc/build/tutorial/data_select.rst
doc/build/tutorial/metadata.rst