Clarify argument format in groupBy#6366
Clarify argument format in groupBy#6366franzholz wants to merge 3 commits intoTYPO3-Documentation:mainfrom
Conversation
It is quoted automatically. The generation of the documentation needs an escape character. See https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html
| * Each argument is either a field name (e.g. in :sql:`GROUP BY \`bodytext\``), | ||
| a :php:`table.fieldName` or a :php:`tableAlias.fieldName`. And it gets properly | ||
| quoted automatically. |
There was a problem hiding this comment.
| * Each argument is either a field name (e.g. in :sql:`GROUP BY \`bodytext\``), | |
| a :php:`table.fieldName` or a :php:`tableAlias.fieldName`. And it gets properly | |
| quoted automatically. | |
| * `$myGroupArray` can consist of one or several field names, separated by comma. It is possible and might be required to precede each field name with table name or table alias, for example :php:`table.fieldName` or :php:`tableAlias.fieldName`. In the resulting query fields are automatically properly quoted. |
There was a problem hiding this comment.
Your explanation is too long. It should be shorter. No need to explain the PHP syntax.
There was a problem hiding this comment.
Then I'd
| * Each argument is either a field name (e.g. in :sql:`GROUP BY \`bodytext\``), | |
| a :php:`table.fieldName` or a :php:`tableAlias.fieldName`. And it gets properly | |
| quoted automatically. | |
| * `Here one or several field names, separated by comma are added. It is possible to precede each field name with table name or table alias. In the resulting query fields are automatically properly quoted. |
There was a problem hiding this comment.
Remove the "separated by comma". PHP developers know this.
Remove the first sentence. It is a repetition of the line above.
The quoting sentence should be shorter.
There was a problem hiding this comment.
See my changed texts.
There was a problem hiding this comment.
I think it's getting worse than the initial phrasing before your change. I tried to "save" your desire to improve here something but would rather vote to reject your commit then.
There was a problem hiding this comment.
sorry, saw your latest commit, I think it's ok like that.
|
Thanks for the contribution. After review by the documentation team, we’ve decided not to proceed with this change. The current wording already meets our requirements for clarity and precision in reference documentation, and we don’t see a net improvement here. We’re therefore closing this PR. |
|
I just wanted to get almost the same description for groupBy as it is done some lines before for orderBy, because I think that this makes it easier to understand the meaning. |
It is quoted automatically.
The generation of the documentation needs an escape character.
See
https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html