Skip to content

Commit a2e3a85

Browse files
authored
PEP 751: Ensure consistent "packages" table name (#4212)
1 parent 7cd93f5 commit a2e3a85

File tree

1 file changed

+39
-39
lines changed

1 file changed

+39
-39
lines changed

peps/pep-0751.rst

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -245,12 +245,12 @@ order. Usage of inline tables SHOULD also be kept consistent.
245245

246246
.. Source
247247
248-
``[packaging.vcs]``
248+
``[packages.vcs]``
249249
-------------------
250250

251251
- **Type**: table
252-
- **Required?**: no; mutually-exclusive with ``packaging.directory``,
253-
``packaging.archive``, ``packaging.sdist``, and ``packaging.wheels``
252+
- **Required?**: no; mutually-exclusive with ``packages.directory``,
253+
``packages.archive``, ``packages.sdist``, and ``packages.wheels``
254254
- **Inspiration**: :ref:`packaging:direct-url-data-structure`
255255
- Record the version control system details for the
256256
:ref:`source tree <packaging:source-distribution-format-source-tree>` it
@@ -261,7 +261,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
261261
systems.
262262

263263

264-
``packaging.vcs.type``
264+
``packages.vcs.type``
265265
''''''''''''''''''''''
266266

267267
- **Type**: string; supported values specified in
@@ -271,7 +271,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
271271
- The type of version control system used.
272272

273273

274-
``packaging.vcs.url``
274+
``packages.vcs.url``
275275
'''''''''''''''''''''
276276

277277
- **Type**: string
@@ -280,7 +280,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
280280
- The URL to the source tree.
281281

282282

283-
``packaging.vcs.path``
283+
``packages.vcs.path``
284284
''''''''''''''''''''''
285285

286286
- **Type**: string
@@ -292,7 +292,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
292292
for portability.
293293

294294

295-
``packaging.vcs.requested-revision``
295+
``packages.vcs.requested-revision``
296296
''''''''''''''''''''''''''''''''''''
297297

298298
- **Type**: string
@@ -304,7 +304,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
304304
the repository.
305305

306306

307-
``packaging.vcs.commit-id``
307+
``packages.vcs.commit-id``
308308
'''''''''''''''''''''''''''
309309

310310
- **Type**: string
@@ -316,7 +316,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
316316
the source code.
317317

318318

319-
``packaging.vcs.subdirectory``
319+
``packages.vcs.subdirectory``
320320
''''''''''''''''''''''''''''''
321321

322322
- **Type**: string
@@ -329,12 +329,12 @@ order. Usage of inline tables SHOULD also be kept consistent.
329329
- The path MUST be relative to the root of the source tree structure.
330330

331331

332-
``[packaging.directory]``
332+
``[packages.directory]``
333333
-------------------------
334334

335335
- **Type**: table
336-
- **Required?**: no; mutually-exclusive with ``packaging.vcs``,
337-
``packaging.archive``, ``packaging.sdist``, and ``packaging.wheels``
336+
- **Required?**: no; mutually-exclusive with ``packages.vcs``,
337+
``packages.archive``, ``packages.sdist``, and ``packages.wheels``
338338
- **Inspiration**: :ref:`packaging:direct-url-data-structure-local-directory`
339339
- Record the local directory details for the
340340
:ref:`source tree <packaging:source-distribution-format-source-tree>` it
@@ -344,7 +344,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
344344
- Tools SHOULD provide a way for users to opt out of using local directories.
345345

346346

347-
``packaging.directory.path``
347+
``packages.directory.path``
348348
''''''''''''''''''''''''''''
349349

350350
- **Type**: string
@@ -356,7 +356,7 @@ order. Usage of inline tables SHOULD also be kept consistent.
356356
portability.
357357

358358

359-
``packaging.directory.editable``
359+
``packages.directory.editable``
360360
''''''''''''''''''''''''''''''''
361361

362362
- **Type**: boolean
@@ -365,13 +365,13 @@ order. Usage of inline tables SHOULD also be kept consistent.
365365
- A flag representing whether the source tree should be installed as editable.
366366

367367

368-
``packaging.directory.subdirectory``
368+
``packages.directory.subdirectory``
369369
''''''''''''''''''''''''''''''''''''
370370

371-
See ``packaging.vcs.subdirectory``.
371+
See ``packages.vcs.subdirectory``.
372372

373373

374-
``[packaging.archive]``
374+
``[packages.archive]``
375375
-----------------------
376376

377377
- **Type**: table
@@ -384,19 +384,19 @@ See ``packaging.vcs.subdirectory``.
384384
- Tools SHOULD provide a way for users to opt out of using archive files.
385385

386386

387-
``packaging.archive.url``
387+
``packages.archive.url``
388388
'''''''''''''''''''''''''
389389

390-
See ``packaging.vcs.url``.
390+
See ``packages.vcs.url``.
391391

392392

393-
``packaging.archive.path``
393+
``packages.archive.path``
394394
''''''''''''''''''''''''''
395395

396-
See ``packaging.vcs.path``.
396+
See ``packages.vcs.path``.
397397

398398

399-
``packaging.archive.size``
399+
``packages.archive.size``
400400
''''''''''''''''''''''''''
401401

402402
- **Type**: integer
@@ -405,7 +405,7 @@ See ``packaging.vcs.path``.
405405
- The size of the archive file.
406406

407407

408-
``[packaging.archive.hashes]``
408+
``[packages.archive.hashes]``
409409
''''''''''''''''''''''''''''''
410410

411411
- **Type**: Table of strings
@@ -420,10 +420,10 @@ See ``packaging.vcs.path``.
420420
recommended.
421421

422422

423-
``packaging.archive.subdirectory``
423+
``packages.archive.subdirectory``
424424
''''''''''''''''''''''''''''''''''
425425

426-
See ``packaging.vcs.subdirectory``.
426+
See ``packages.vcs.subdirectory``.
427427

428428

429429
``packages.index``
@@ -442,8 +442,8 @@ See ``packaging.vcs.subdirectory``.
442442
--------------------
443443

444444
- **Type**: table
445-
- **Required?**: no; mutually-exclusive with ``packaging.vcs``,
446-
``packaging.directory``, and ``packaging.archive``
445+
- **Required?**: no; mutually-exclusive with ``packages.vcs``,
446+
``packages.directory``, and ``packages.archive``
447447
- **Inspiration**: uv_
448448
- Details of a :ref:`packaging:source-distribution-format-sdist` for the
449449
package.
@@ -476,34 +476,34 @@ See ``packaging.vcs.subdirectory``.
476476
``packages.sdist.url``
477477
''''''''''''''''''''''
478478

479-
See ``packaging.archive.url``.
479+
See ``packages.archive.url``.
480480

481481

482482
``packages.sdist.path``
483483
'''''''''''''''''''''''
484484

485-
See ``packaging.archive.path``.
485+
See ``packages.archive.path``.
486486

487487

488488
``packages.sdist.size``
489489
'''''''''''''''''''''''
490490

491-
See ``packaging.archive.size``.
491+
See ``packages.archive.size``.
492492

493493

494494
``packages.sdist.hashes``
495495
'''''''''''''''''''''''''
496496

497-
See ``packaging.archive.hashes``.
497+
See ``packages.archive.hashes``.
498498

499499

500500

501501
``[[packages.wheels]]``
502502
-----------------------
503503

504504
- **Type**: array of tables
505-
- **Required?**: no; mutually-exclusive with ``packaging.vcs``,
506-
``packaging.directory``, and ``packaging.archive``
505+
- **Required?**: no; mutually-exclusive with ``packages.vcs``,
506+
``packages.directory``, and ``packages.archive``
507507
- **Inspiration**: PDM_, Poetry_, uv_
508508
- For recording the wheel files as specified by
509509
:ref:`packaging:binary-distribution-format` for the package.
@@ -529,25 +529,25 @@ See ``packages.sdist.upload-time``.
529529
``packages.wheels.url``
530530
'''''''''''''''''''''''
531531

532-
See ``packaging.archive.url``.
532+
See ``packages.archive.url``.
533533

534534

535535
``packages.wheels.path``
536536
''''''''''''''''''''''''
537537

538-
See ``packaging.archive.path``.
538+
See ``packages.archive.path``.
539539

540540

541541
``packages.wheels.size``
542542
''''''''''''''''''''''''
543543

544-
See ``packaging.archive.size``.
544+
See ``packages.archive.size``.
545545

546546

547547
``packages.wheels.hashes``
548548
''''''''''''''''''''''''''
549549

550-
See ``packaging.archive.hashes``.
550+
See ``packages.archive.hashes``.
551551

552552

553553

@@ -816,7 +816,7 @@ At one point, to handle the issue of metadata varying between files and thus
816816
require examining every released file for a package and version for accurate
817817
locking results, the idea was floated to introduce a new core metadata version
818818
which would require all metadata for all wheel files be the same for a single
819-
version of a packages. Ultimately, though, it was deemed unnecessary as this PEP
819+
version of a package. Ultimately, though, it was deemed unnecessary as this PEP
820820
will put pressure on people to make files consistent for performance reasons or
821821
to make indexes provide all the metadata separate from the wheel files
822822
themselves. As well, there's no easy enforcement mechanism, and so community
@@ -1046,7 +1046,7 @@ although the chances are people will expect it to be implemented as it shouldn't
10461046
increase the complexity of an installer drastically.
10471047

10481048

1049-
Make ``packaging.wheels`` a table
1049+
Make ``packages.wheels`` a table
10501050
=================================
10511051

10521052
One could see writing out wheel file details as a table keyed on the file name.

0 commit comments

Comments
 (0)