Skip to content

Commit 4953008

Browse files
committed
Remove incorrect use of quotes in csv table headers
1 parent 7730216 commit 4953008

13 files changed

+52
-52
lines changed

development/cli/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ General options
6161
Common options that can be used with any of phpBB's CLI commands.
6262

6363
.. csv-table::
64-
:header: "Option", "Usage"
64+
:header: Option, Usage
6565
:delim: |
6666

6767
``--help, -h`` | Display a help message

development/db/dbal.rst

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Parameters
5353
^^^^^^^^^^
5454

5555
.. csv-table::
56-
:header: "Parameter", "Usage"
56+
:header: Parameter, Usage
5757
:delim: #
5858

5959
Host # The host of the database. |br| When using config.php you should use $dbhost instead.
@@ -118,7 +118,7 @@ Example:
118118
Parameters
119119
^^^^^^^^^^
120120
.. csv-table::
121-
:header: "Parameter", "Usage"
121+
:header: Parameter, Usage
122122
:delim: #
123123

124124
Query Type # Type of query which needs to be created (SELECT, SELECT_DISTINCT)
@@ -158,7 +158,7 @@ Example:
158158
Parameters
159159
^^^^^^^^^^
160160
.. csv-table::
161-
:header: "Parameter", "Usage"
161+
:header: Parameter, Usage
162162
:delim: #
163163

164164
Query Type # Type of query which needs to be created (UPDATE, INSERT, INSERT_SELECT or SELECT)
@@ -182,7 +182,7 @@ Example:
182182
Parameters
183183
^^^^^^^^^^
184184
.. csv-table::
185-
:header: "Parameter", "Usage"
185+
:header: Parameter, Usage
186186
:delim: |
187187

188188
Column | Name of the sql column that shall be compared
@@ -207,7 +207,7 @@ Example:
207207
Parameters
208208
^^^^^^^^^^
209209
.. csv-table::
210-
:header: "Parameter", "Usage"
210+
:header: Parameter, Usage
211211
:delim: |
212212

213213
String | The string that needs to be escaped.
@@ -223,7 +223,7 @@ The ``sql_not_like_expression`` is identical to ``sql_like_expression`` apart fr
223223
Parameters
224224
^^^^^^^^^^
225225
.. csv-table::
226-
:header: "Parameter", "Usage"
226+
:header: Parameter, Usage
227227
:delim: |
228228

229229
Expression | The expression to use. Every wildcard is escaped, except $db->get_any_char() and $db->get_one_char()
@@ -269,7 +269,7 @@ Example:
269269
Parameters
270270
^^^^^^^^^^
271271
.. csv-table::
272-
:header: "Parameter", "Usage"
272+
:header: Parameter, Usage
273273
:delim: |
274274

275275
Column name | The column name to LOWER the value for.
@@ -298,7 +298,7 @@ Example:
298298
Parameters
299299
^^^^^^^^^^
300300
.. csv-table::
301-
:header: "Parameter", "Usage"
301+
:header: Parameter, Usage
302302
:delim: |
303303

304304
Query | Contains the SQL query which shall be executed
@@ -323,7 +323,7 @@ Example:
323323
Parameters
324324
^^^^^^^^^^
325325
.. csv-table::
326-
:header: "Parameter", "Usage"
326+
:header: Parameter, Usage
327327
:delim: |
328328

329329
Query | Contains the SQL query which shall be executed.
@@ -359,7 +359,7 @@ Example:
359359
Parameters
360360
^^^^^^^^^^
361361
.. csv-table::
362-
:header: "Parameter", "Usage"
362+
:header: Parameter, Usage
363363
:delim: |
364364

365365
Table name | Table name to run the statements on.
@@ -427,7 +427,7 @@ Example:
427427
Parameters
428428
^^^^^^^^^^
429429
.. csv-table::
430-
:header: "Parameter", "Usage"
430+
:header: Parameter, Usage
431431
:delim: #
432432

433433
Field # Name of the field that needs to be fetched.
@@ -442,7 +442,7 @@ Returns an array with the result of using the ``sql_fetchrow`` method on every r
442442
Parameters
443443
^^^^^^^^^^
444444
.. csv-table::
445-
:header: "Parameter", "Usage"
445+
:header: Parameter, Usage
446446
:delim: #
447447

448448
Result (Optional) # The result that is being evaluated. |br| This result comes from a call to the sql_query method. |br| If left empty the last result will be called.
@@ -480,7 +480,7 @@ Example with a while-loop:
480480
Parameters
481481
^^^^^^^^^^
482482
.. csv-table::
483-
:header: "Parameter", "Usage"
483+
:header: Parameter, Usage
484484
:delim: #
485485

486486
Result (Optional) # The result that is being evaluated. |br| The result comes from a call to the sql_query method. |br| If left empty the last result will be called.
@@ -493,7 +493,7 @@ Seeks to given row number. The row number is zero-based. Defined in the specific
493493
Parameters
494494
^^^^^^^^^^
495495
.. csv-table::
496-
:header: "Parameter", "Usage"
496+
:header: Parameter, Usage
497497
:delim: #
498498

499499
Row number # The number of the row which needs to be found (zero-based).
@@ -523,7 +523,7 @@ Example:
523523
Parameters
524524
^^^^^^^^^^
525525
.. csv-table::
526-
:header: "Parameter", "Usage"
526+
:header: Parameter, Usage
527527
:delim: #
528528

529529
Result (Optional) # The result that is being evaluated. |br| This result comes from a call to the sql_query method. |br| If left empty the last result will be called.

development/extensions/modification_to_extension.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ matter which files, may it be styles, language or ACP module files. All of them
2525
should be moved into your extension's directory:
2626

2727
.. csv-table::
28-
:header: "new directory", "current directory"
28+
:header: new directory, current directory
2929
:delim: |
3030

3131
``acp/*_module.php`` | ``phpBB/includes/acp/``

development/extensions/new_in_rhea.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ New Language Object
2929
A new Language object has been introduced that decouples language functions from the User object. That is to say, the following language functions now belong to the ``\phpbb\language\language`` class:
3030

3131
.. csv-table::
32-
:header: "Function", "Description"
32+
:header: Function, Description
3333
:delim: |
3434

3535
``lang`` | "Advanced language substitution."
@@ -79,7 +79,7 @@ As of phpBB 3.2, a new and more powerful BBCode formatting engine has been integ
7979
The new engine has already been equipped with many PHP events making it even easier than before for extensions to configure BBCodes and BBCode formatted text. The following are the new PHP events:
8080

8181
.. csv-table::
82-
:header: "Event", "Description"
82+
:header: Event, Description
8383
:delim: |
8484

8585
``core.text_formatter_s9e_configure_before`` | "Modify the s9e\TextFormatter configurator before the default settings are set."

development/extensions/tutorial_advanced.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -471,7 +471,7 @@ file:
471471
}
472472
473473
.. csv-table::
474-
:header: "Parameter", "Description"
474+
:header: Parameter, Description
475475
:delim: |
476476

477477
``host`` | "Full URL to the host domain server."
@@ -519,7 +519,7 @@ used for stable release versions suitable for a live forum. The unstable
519519
branch can be used to provide links to versions in development.
520520

521521
.. csv-table::
522-
:header: "Parameter", "Description"
522+
:header: Parameter, Description
523523
:delim: |
524524

525525
``current`` | "The current version of the extension in a given branch."

development/extensions/tutorial_basics.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ The details of the meta data are explained below the sample, but for now let's h
9292
It is important to remember that the last item or object in any JSON array must not contain a trailing comma.
9393

9494
.. csv-table::
95-
:header: "Field", "Required", "Content"
95+
:header: Field, Required, Content
9696
:delim: |
9797

9898
``name`` | Yes | "The vendor name and extension name, separated by ``/``, matching the folder
@@ -124,7 +124,7 @@ authors
124124
You may have unlimited authors. At least one author is highly recommended.
125125

126126
.. csv-table::
127-
:header: "Field", "Required", "Content"
127+
:header: Field, Required, Content
128128
:delim: |
129129

130130
``name`` | Yes | "The name of an author."
@@ -140,7 +140,7 @@ List the dependencies required by the extension, i.e. the PHP version and
140140
`third party libraries <https://packagist.org/>`_.
141141

142142
.. csv-table::
143-
:header: "Field", "Content"
143+
:header: Field, Content
144144
:delim: |
145145

146146
``php`` | "The minimum-stability version of PHP required by the extension. phpBB 3.2 requires PHP 5.4.0 or higher,
@@ -163,7 +163,7 @@ This section can contain virtually any arbitrary data according to the composer
163163
two special entries in this array for extensions:
164164

165165
.. csv-table::
166-
:header: "Field", "Content"
166+
:header: Field, Content
167167
:delim: |
168168

169169
``display-name`` | "The name of your extension, e.g. Acme Demo Extension."

development/extensions/tutorial_bbcodes.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Toggle BBCodes On / Off
2323
BBCodes and other tags can be toggled before or after parsing using any of the following events:
2424

2525
.. csv-table::
26-
:header: "Event", "Description"
26+
:header: Event, Description
2727
:delim: |
2828

2929
``core.text_formatter_s9e_parser_setup`` | Triggers once, when the text Parser service is first created.
@@ -34,7 +34,7 @@ Most common operations are available through the Parser service using the ``phpb
3434
This includes the functions:
3535

3636
.. csv-table::
37-
:header: "Function", "Description"
37+
:header: Function, Description
3838
:delim: |
3939

4040
``disable_bbcode($name)`` | Disable a BBCode
@@ -147,7 +147,7 @@ that will only show its content to registered users.
147147
Default phpBB template parameters:
148148

149149
.. csv-table::
150-
:header: "Variable", "Description"
150+
:header: Variable, Description
151151
:delim: |
152152

153153
``S_IS_BOT`` | Whether the current user is a bot.
@@ -210,7 +210,7 @@ users can see the contents of:
210210
Template parameters can also be set using any of the following events:
211211

212212
.. csv-table::
213-
:header: "Event", "Description"
213+
:header: Event, Description
214214
:delim: |
215215

216216
``core.text_formatter_s9e_renderer_setup`` | Triggers once, when the renderer service is created.

development/extensions/tutorial_controllers.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ our route definition:
280280
name: \d+
281281
282282
.. csv-table::
283-
:header: "Item", "Description"
283+
:header: Item, Description
284284
:delim: |
285285

286286
route | "The route name is a unique name and must be prefixed with the vendor and extension names. Use only lowercase letters and underscores."

development/extensions/tutorial_modules.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ The ``main_info`` class has only one method ``module()`` which returns an array
7474
with the following information:
7575

7676
.. csv-table::
77-
:header: "Key", "Content"
77+
:header: Key, Content
7878
:delim: |
7979

8080
``filename`` | "Fully name-spaced path to the `Module class`_, starting with a leading slash."
@@ -86,7 +86,7 @@ with the following information:
8686
Note that we have defined one mode named ``settings`` with the following information:
8787

8888
.. csv-table::
89-
:header: "Key", "Content"
89+
:header: Key, Content
9090
:delim: |
9191

9292
``title`` | "Language key of the mode-title that is displayed in the ACP module

development/extensions/tutorial_notifications.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ Base Services
309309
The base notification type class (:class:`\\phpbb\\notification\\type\\base`) already has a few available services which can be used in our class's functions.
310310

311311
.. csv-table::
312-
:header: "Object", "Class"
312+
:header: Object, Class
313313
:delim: |
314314

315315
``$auth`` | :class:`\\phpbb\\auth\\auth`
@@ -663,7 +663,7 @@ But if you are using the email method, then you should use this function to defi
663663
However, note that the phpBB core already defines some *default* variables for you:
664664

665665
.. csv-table::
666-
:header: "Variable", "Description", "Defined in"
666+
:header: Variable, Description, Defined in
667667
:delim: #
668668

669669
``USERNAME`` # The recipient's username # :class:`\\phpbb\\notification\\method\\messenger_base` ``notify_using_messenger()``
@@ -964,7 +964,7 @@ Optionally you can send a third argument, ``$options``, to specify which notific
964964
The options that can be defined are listed below:
965965

966966
.. csv-table::
967-
:header: "Object", "Class"
967+
:header: Object, Class
968968
:delim: #
969969

970970
``item_id`` # The item identifier for the notification. |br| Defaults to get_item_id_
@@ -1037,7 +1037,7 @@ Parameters
10371037
^^^^^^^^^^
10381038

10391039
.. csv-table::
1040-
:header: "Parameter", "Description"
1040+
:header: Parameter, Description
10411041
:delim: #
10421042

10431043
**notification_type** # The notification service identifier. |br| Can be a single string or an array of service identifiers. |br| In this example: ``vendor.extension.notification.type.sample``.
@@ -1084,7 +1084,7 @@ Parameters
10841084
^^^^^^^^^^
10851085

10861086
.. csv-table::
1087-
:header: "Parameter", "Description"
1087+
:header: Parameter, Description
10881088
:delim: #
10891089

10901090
**notification_type** # Can be a single string or an array of service identifiers. |br| In this example: ``vendor.extension.notification.type.sample``.
@@ -1100,7 +1100,7 @@ Parameters
11001100
^^^^^^^^^^
11011101

11021102
.. csv-table::
1103-
:header: "Parameter", "Description"
1103+
:header: Parameter, Description
11041104
:delim: #
11051105

11061106
**notification_type** # Can be a single string or an array of service identifiers. |br| In this example: ``vendor.extension.notification.type.sample``.
@@ -1121,7 +1121,7 @@ Parameters
11211121
^^^^^^^^^^
11221122

11231123
.. csv-table::
1124-
:header: "Parameter", "Description"
1124+
:header: Parameter, Description
11251125
:delim: #
11261126

11271127
**method_name** # The notification method service identifier |br| For example: ``notification.method.board``

development/migrations/dependencies.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ depends_on creates a tree
5959
Imagine the following situation:
6060

6161
.. csv-table::
62-
:header: "Migration", "Dependencies", "Note"
62+
:header: Migration, Dependencies, Note
6363
:delim: |
6464

6565
``migration_1`` | ``phpbb\db\migration\data\\v310\\dev`` | Initial release, 1.0.0, requires phpBB 3.1.0
@@ -74,7 +74,7 @@ installed when an individual Migration was installed manually. *Assumes*
7474

7575

7676
.. csv-table::
77-
:header: "Install", "Migrations that are installed"
77+
:header: Install, Migrations that are installed
7878
:delim: |
7979

8080
``migration_1`` | ``migration_1``

development/migrations/tools/module.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Add a new module
1414
['module.add', [ mixed $class [, mixed $parent [, array $data [, mixed $include_path ]]] ]]
1515
1616
.. csv-table::
17-
:header: "Parameter", "Required/Default", "Usage"
17+
:header: Parameter, Required/Default, Usage
1818
:delim: |
1919

2020
class | Required | The module class: acp, mcp, or ucp
@@ -112,7 +112,7 @@ Parameters
112112
----------
113113

114114
.. csv-table::
115-
:header: "Parameter", "Required/Default", "Usage"
115+
:header: Parameter, Required/Default, Usage
116116
:delim: |
117117

118118
class | Required | The module class: acp, mcp, or ucp

0 commit comments

Comments
 (0)