Update comment on the schema_filter key #1165
Conversation
Resources/doc/configuration.rst
Outdated
| @@ -95,7 +95,7 @@ Configuration Reference | |||
| platform_service: ~ | |||
| auto_commit: ~ | |||
|
|
|||
| # If set to "/^sf2_/" all tables not prefixed with "sf2_" will be ignored by the schema | |||
| # If set to "/^sf2_/" all tables, and any named objects such as sequences, not prefixed with "sf2_" will be ignored by the schema | |||
There was a problem hiding this comment.
Please wrap the comment consistently with the previous version
There was a problem hiding this comment.
WDYM? In both versions it's single line so no wrapping, isn't it?
There was a problem hiding this comment.
I was not talking about the previous version of the line, but about the previous version of the sentence, and the end of the sentence is on a new line (tool. is on line 99), so there is wrapping. The goal here is to avoid horizontal in the docs, let's not make the docs harder to read.
Resources/doc/configuration.rst
Outdated
| @@ -95,8 +95,8 @@ Configuration Reference | |||
| platform_service: ~ | |||
| auto_commit: ~ | |||
|
|
|||
| # If set to "/^sf2_/" all tables, and any named objects such as sequences, not prefixed with "sf2_" will be ignored by the schema | |||
| # tool. This is for custom tables which should not be altered automatically. | |||
| # If set to "/^sf2_/" all tables, and any named objects such as sequences, not prefixed with "sf2_" will be ignored by the schema tool. | |||
There was a problem hiding this comment.
What I mean by wrapping is avoiding long lines by splitting them when reaching a certain length
There was a problem hiding this comment.
Current state of this patch is fine by me. This is not a longest line we have here, check https://github.com/doctrine/DoctrineBundle/pull/1165/files#diff-93d26a68e69554f4bf0e01c6245dc390L495. Can't really imagine how would we split this to more lines, split sentence at random point? I don't see this done anywhere else in this document.
Either that or you can use https://sembr.org/ if you want. My point is, this is going to look really bad here: You should not have to scroll horizontally here, one dimension to explore should be enough. |
|
But it is currently split, look: DoctrineBundle/Resources/doc/configuration.rst Lines 98 to 100 in 0ea57dc
IIRC someone (Javier Eguiluz?) asked how we could improve this, and we didn't find a solution, but let's not make it worse, ok? If people just need to have a look at the docs for EDIT: ah I was confusing with this somewhat related, but not completely discussion |
See doctrine/dbal#3986 The `schema_filter` key does not filter only tables. Co-authored-by: Grégoire Paris <postmaster@greg0ire.fr>
See doctrine/dbal#3986
The
schema_filterkey does not filter only tables.