Address split of doctrine/common #11007
Conversation
docs/en/reference/architecture.rst
Outdated
| - ORM (includes DBAL+Common) | ||
| - Persistence | ||
| - DBAL | ||
| - ORM (includes DBAL+Persistence) |
There was a problem hiding this comment.
I would say "depends on" rather than "includes"
docs/en/reference/architecture.rst
Outdated
| ~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The Common package contains highly reusable components that have no | ||
| The Persistence package contains highly reusable components that have no |
There was a problem hiding this comment.
This sentence probably refers more to doctrine/collections than doctrine/persistence. Maybe it should be mentioned as well.
docs/en/reference/architecture.rst
Outdated
| - DBAL (includes Common) | ||
| - ORM (includes DBAL+Common) | ||
| - Persistence | ||
| - DBAL |
There was a problem hiding this comment.
As those are about separate packages that have their own docs, should we have links to their docs ?
greg0ire
force-pushed
the
refresh-archi-docs
branch
from
3282f00 to
5134f40
Compare
docs/en/reference/architecture.rst
Outdated
| - `Collections <https://www.doctrine-project.org/projects/doctrine-collections/en/stable/index.html>`_ | ||
| - `Persistence <https://www.doctrine-project.org/projects/doctrine-persistence/en/stable/index.html>`_ | ||
| - `DBAL <https://www.doctrine-project.org/projects/doctrine-dbal/en/stable/index.html>`_ | ||
| - ORM (depends on DBAL+Persistence) |
greg0ire
force-pushed
the
refresh-archi-docs
branch
from
5134f40 to
b2f78a8
Compare
docs/en/reference/architecture.rst
Outdated
| is split in to these packages for a few reasons and they are to... | ||
|
|
||
|
|
||
| - ...make things more maintainable and decoupled | ||
| - ...allow you to use the code in Doctrine Common without the ORM | ||
| - ...allow you to use the code in Doctrine Persistence without the ORM |
greg0ire
force-pushed
the
refresh-archi-docs
branch
from
b2f78a8 to
4a03e66
Compare
docs/en/reference/architecture.rst
Outdated
| The Collection and Persistence package contains highly reusable | ||
| components that have no dependencies beyond the package itself (and PHP, | ||
| of course). The root namespace of the Persistence package is |
There was a problem hiding this comment.
Persistence has a dependency to the Event-Manager. I'm not sure what this paragraph was supposed to mean back then and now. That these packages are lightweight without a dependency chain?
There was a problem hiding this comment.
I guess this paragraph was true for common: at that time, event-manager was part of common as well.
There was a problem hiding this comment.
I should use the plural, which will make the sentence "beyond the package themselves". If I add Persistence to the paragraph, this "themselves" will be vague enough that it can mean "each other" I think.
doctrine/common has been split in several packages. A lot of what was true about doctrine/common is true about doctrine/persistence today, so let us simply reuse the existing paragraphs and mention persistence instead of common.
greg0ire
force-pushed
the
refresh-archi-docs
branch
from
4a03e66 to
d84f607
Compare
doctrine/common has been split in several packages. A lot of what was true about doctrine/common is true about doctrine/persistence today, so let us simply reuse the existing paragraphs and mention persistence instead of common.