Skip to content

Commit

Permalink
Fixed inaccuracies in documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
GrandLTU committed Feb 5, 2015
1 parent a832d9a commit 26d6fb0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions Resources/doc/sync/descriptors/descriptors.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Descriptors
===========

Sql descriptors are special classes that tell extractor which fields/tables to watch for changes.
Extraction descriptors are special classes that tell extractor which fields/tables to watch for changes.

By default, all services tagged with a ``{ name: ongr_connections.extraction_descriptor }`` are added to a single service
called ``ongr_connections.sync.extraction_collection``, which later on can be passed as a parameter for
Expand Down Expand Up @@ -80,7 +80,7 @@ Cascading changes
There are classes that help implement cascading data changes, e.g. if you have changed the name of the
category, you also have to update all the products which use said categories' name.

``Extractor\Relation\JoinRelation`` class does exactly that: you can attach it to a relation and when changes are
``Extractor\Descriptor\JoinRelation`` class does exactly that: you can attach it to a descriptor and when changes are
detected, `extractor <../extractor/extractor.rst>`_ calls the relations and marks related documents as changed.

If ``$documentType`` is left undefined document itself will not be marked as changed but related items will.
Expand Down
4 changes: 2 additions & 2 deletions Resources/doc/sync/sync.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ obtain a Diff object to be stored in `synchronization storage <storage/sync_stor
Data Sync Provide consume event listener service uses `Extractor <extractor/extractor.rst>`_ to parse the Diff object
and `Sync Storage Provider <storage/sync_storage.rst>`_ to write the ids of changed objects.

Extractor on its' own accord iterates through `extraction Descriptors <descriptors/descriptors.rst>`_ to ensure that objects which are "watched" are
Extractor on its' own accord iterates through `Extraction Descriptors <descriptors/descriptors.rst>`_ to ensure that objects which are "watched" are
included in the change list.

Each Descriptor iterates through `joint relations <descriptors/descriptors.rst>`_ which ensure that the related objects
Expand Down Expand Up @@ -69,7 +69,7 @@ This bundle provides implementation which uses mysql database as synchronization
Configuration
~~~~~~~~~~~~~

See `SQL Relations documentation <descriptors/sql_relations.rst>`_ for information on how to configure what should be
See `Extraction Descriptors documentation <descriptors/sql_relations.rst>`_ for information on how to configure what should be
included in continuous synchronization.

Sub-topics
Expand Down

0 comments on commit 26d6fb0

Please sign in to comment.