Skip to content

Commit b026e18

Browse files
committed
docs: Use func instead of meth RST ref
1 parent 35428b7 commit b026e18

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

docs/changelog.rst

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Changed
99

1010
- Some arguments must be keyword arguments in:
1111

12-
- :meth:`ocdskit.mapping_sheet.mapping_sheet`
13-
- :meth:`ocdskit.schema.add_validation_properties`
14-
- :meth:`ocdskit.util.iterencode`
15-
- :meth:`ocdskit.util.json_dump`
16-
- :meth:`ocdskit.util.json_dumps`
12+
- :func:`ocdskit.mapping_sheet.mapping_sheet`
13+
- :func:`ocdskit.schema.add_validation_properties`
14+
- :func:`ocdskit.util.iterencode`
15+
- :func:`ocdskit.util.json_dump`
16+
- :func:`ocdskit.util.json_dumps`
1717

1818
- Drop support for Python 3.8.
1919

@@ -23,23 +23,23 @@ Changed
2323
Added
2424
~~~~~
2525

26-
- :meth:`ocdskit.combine.merge` accepts a ``convert_exceptions_to_warnings`` argument.
26+
- :func:`ocdskit.combine.merge` accepts a ``convert_exceptions_to_warnings`` argument.
2727

2828
1.1.12 (2024-05-07)
2929
-------------------
3030

3131
Added
3232
~~~~~
3333

34-
- :meth:`ocdskit.combine.merge` accepts a ``force_version`` argument.
34+
- :func:`ocdskit.combine.merge` accepts a ``force_version`` argument.
3535

3636
1.1.11 (2024-05-01)
3737
-------------------
3838

3939
Added
4040
~~~~~
4141

42-
- :meth:`ocdskit.combine.merge` accepts a ``ignore_version`` argument.
42+
- :func:`ocdskit.combine.merge` accepts a ``ignore_version`` argument.
4343

4444
1.1.10 (2024-04-15)
4545
-------------------
@@ -52,15 +52,15 @@ Added
5252
Changed
5353
~~~~~~~
5454

55-
- :meth:`ocdskit.util.detect_format`: Detect empty packages that set metadata fields but not a ``releases`` or ``records`` field.
55+
- :func:`ocdskit.util.detect_format`: Detect empty packages that set metadata fields but not a ``releases`` or ``records`` field.
5656

5757
1.1.9 (2024-01-05)
5858
------------------
5959

6060
Added
6161
~~~~~
6262

63-
- :meth:`ocdskit.util.is_linked_release` accepts a ``maximum_properties`` argument (default 3).
63+
- :func:`ocdskit.util.is_linked_release` accepts a ``maximum_properties`` argument (default 3).
6464
- Drop support for Python 3.7.
6565

6666
1.1.8 (2023-06-26)
@@ -113,16 +113,16 @@ Changed
113113
Fixed
114114
~~~~~
115115

116-
- :meth:`ocdskit.mapping_sheet.mapping_sheet` works if a schema contains ``"deprecated": null``.
117-
- :meth:`ocdskit.mapping_sheet.mapping_sheet` works if ``--extension-field`` is set to a value other than "extension".
116+
- :func:`ocdskit.mapping_sheet.mapping_sheet` works if a schema contains ``"deprecated": null``.
117+
- :func:`ocdskit.mapping_sheet.mapping_sheet` works if ``--extension-field`` is set to a value other than "extension".
118118

119119
1.1.3 (2022-10-20)
120120
------------------
121121

122122
Fixed
123123
~~~~~
124124

125-
- :meth:`ocdskit.mapping_sheet.mapping_sheet` works if ``include_definitions=False`` but ``base_uri`` is not provided.
125+
- :func:`ocdskit.mapping_sheet.mapping_sheet` works if ``include_definitions=False`` but ``base_uri`` is not provided.
126126

127127
1.1.2 (2022-10-06)
128128
------------------
@@ -139,15 +139,15 @@ Changed
139139
Changed
140140
~~~~~~~
141141

142-
- :meth:`ocdskit.mapping_sheet.mapping_sheet` resolves ``$ref`` properties if ``include_definitions=False``.
142+
- :func:`ocdskit.mapping_sheet.mapping_sheet` resolves ``$ref`` properties if ``include_definitions=False``.
143143

144144
1.1.0 (2022-08-16)
145145
------------------
146146

147147
Changed
148148
~~~~~~~
149149

150-
- :meth:`ocdskit.mapping_sheet.mapping_sheet` returns columns and rows instead of writing to a file-like object.
150+
- :func:`ocdskit.mapping_sheet.mapping_sheet` returns columns and rows instead of writing to a file-like object.
151151

152152
1.0.4 (2022-02-10)
153153
------------------
@@ -165,7 +165,7 @@ New CLI options:
165165
Added
166166
~~~~~
167167

168-
- :meth:`ocdskit.util.get_ocds_patch_tag`
168+
- :func:`ocdskit.util.get_ocds_patch_tag`
169169

170170
Changed
171171
~~~~~~~
@@ -192,7 +192,7 @@ Fixed
192192
Changed
193193
~~~~~~~
194194

195-
- :meth:`ocdskit.util.detect_format` accepts a ``reader`` keyword argument: for example, ``gzip.open`` instead of ``open``.
195+
- :func:`ocdskit.util.detect_format` accepts a ``reader`` keyword argument: for example, ``gzip.open`` instead of ``open``.
196196

197197
1.0.0 (2021-05-19)
198198
------------------
@@ -262,7 +262,7 @@ Added
262262

263263
New library method:
264264

265-
- :meth:`ocdskit.util.detect_format`
265+
- :func:`ocdskit.util.detect_format`
266266

267267
0.2.17 (2020-12-11)
268268
-------------------
@@ -314,7 +314,7 @@ New CLI option:
314314

315315
New library method:
316316

317-
- :meth:`ocdskit.schema.add_validation_properties`
317+
- :func:`ocdskit.schema.add_validation_properties`
318318

319319
0.2.13 (2020-09-16)
320320
-------------------
@@ -330,7 +330,7 @@ Fixed
330330
Changed
331331
~~~~~~~
332332

333-
- :meth:`ocdskit.util.get_ocds_minor_version` now supports records.
333+
- :func:`ocdskit.util.get_ocds_minor_version` now supports records.
334334

335335
Fixed
336336
~~~~~
@@ -394,13 +394,13 @@ New CLI options:
394394

395395
New library method:
396396

397-
- :meth:`ocdskit.util.is_compiled_release`
397+
- :func:`ocdskit.util.is_compiled_release`
398398

399399
Changed
400400
~~~~~~~
401401

402-
- :ref:`compile` sets ``"version": "1.1"`` even on OCDS 1.0 data (see :meth:`ocdskit.combine.merge`).
403-
- :ref:`package-releases` and :ref:`package-records` omit the ``extensions`` field if empty (see :meth:`ocdskit.combine.package_releases` and :meth:`ocdskit.combine.package_records`).
402+
- :ref:`compile` sets ``"version": "1.1"`` even on OCDS 1.0 data (see :func:`ocdskit.combine.merge`).
403+
- :ref:`package-releases` and :ref:`package-records` omit the ``extensions`` field if empty (see :func:`ocdskit.combine.package_releases` and :func:`ocdskit.combine.package_records`).
404404

405405
Fixed
406406
~~~~~
@@ -415,20 +415,20 @@ Added
415415

416416
New library method:
417417

418-
- :meth:`ocdskit.util.is_linked_release`
418+
- :func:`ocdskit.util.is_linked_release`
419419

420420
Changed
421421
~~~~~~~
422422

423-
- :ref:`combine-release-packages` and :ref:`combine-record-packages` warn if the ``"releases"`` and ``"records"`` fields aren't set (see :meth:`ocdskit.combine.combine_release_packages` and :meth:`ocdskit.combine.combine_record_packages`).
423+
- :ref:`combine-release-packages` and :ref:`combine-record-packages` warn if the ``"releases"`` and ``"records"`` fields aren't set (see :func:`ocdskit.combine.combine_release_packages` and :func:`ocdskit.combine.combine_record_packages`).
424424

425425
0.2.5 (2020-04-14)
426426
------------------
427427

428428
Fixed
429429
~~~~~
430430

431-
- :ref:`combine-release-packages` and :ref:`combine-record-packages` no longer error if the ``"releases"`` and ``"records"`` fields aren't set (see :meth:`ocdskit.combine.combine_release_packages` and :meth:`ocdskit.combine.combine_record_packages`).
431+
- :ref:`combine-release-packages` and :ref:`combine-record-packages` no longer error if the ``"releases"`` and ``"records"`` fields aren't set (see :func:`ocdskit.combine.combine_release_packages` and :func:`ocdskit.combine.combine_record_packages`).
432432

433433
0.2.4 (2020-03-19)
434434
------------------
@@ -456,7 +456,7 @@ Changed
456456
~~~~~~~
457457

458458
- :ref:`compile` errors if an ``ocid`` field is missing from a release (see :meth:`ocdskit.packager.AbstractBackend.add_release`).
459-
- :ref:`upgrade` upgrades records (see :meth:`ocdskit.upgrade.upgrade_10_11`).
459+
- :ref:`upgrade` upgrades records (see :func:`ocdskit.upgrade.upgrade_10_11`).
460460

461461
0.2.2 (2020-01-07)
462462
------------------
@@ -492,7 +492,7 @@ Changed
492492
Fixed
493493
~~~~~
494494

495-
- :ref:`combine-record-packages` no longer duplicates release package URLs in ``packages`` field (see :meth:`ocdskit.combine.combine_record_packages`).
495+
- :ref:`combine-record-packages` no longer duplicates release package URLs in ``packages`` field (see :func:`ocdskit.combine.combine_record_packages`).
496496

497497
0.2.0 (2019-12-31)
498498
------------------
@@ -509,12 +509,12 @@ Changed
509509

510510
CLI:
511511

512-
- :ref:`compile` accepts either release packages or individual releases (see :meth:`ocdskit.combine.merge`).
513-
- :ref:`compile` is memory efficient if given a long list of inputs (see :meth:`ocdskit.combine.merge`).
512+
- :ref:`compile` accepts either release packages or individual releases (see :func:`ocdskit.combine.merge`).
513+
- :ref:`compile` is memory efficient if given a long list of inputs (see :func:`ocdskit.combine.merge`).
514514

515515
Library:
516516

517-
- Deprecate ``ocdskit.combine.compile_release_packages`` in favor of :meth:`ocdskit.combine.merge`.
517+
- Deprecate ``ocdskit.combine.compile_release_packages`` in favor of :func:`ocdskit.combine.merge`.
518518

519519
Fixed
520520
~~~~~
@@ -529,8 +529,8 @@ Added
529529

530530
New library methods:
531531

532-
- :meth:`ocdskit.util.is_record`
533-
- :meth:`ocdskit.util.is_release`
532+
- :func:`ocdskit.util.is_record`
533+
- :func:`ocdskit.util.is_release`
534534

535535
The internal methods ``ocdskit.util.json_load`` and ``ocdskit.util.json_loads`` are removed.
536536

@@ -554,7 +554,7 @@ New CLI commands:
554554

555555
New library methods:
556556

557-
- :meth:`ocdskit.combine.package_records`
557+
- :func:`ocdskit.combine.package_records`
558558

559559
Changed
560560
~~~~~~~
@@ -580,7 +580,7 @@ Changed
580580
Changed
581581
~~~~~~~
582582

583-
- Align the library methods :meth:`ocdskit.util.json_dump` and :meth:`ocdskit.util.json_dumps`.
583+
- Align the library methods :func:`ocdskit.util.json_dump` and :func:`ocdskit.util.json_dumps`.
584584

585585
0.1.1 (2019-09-19)
586586
------------------
@@ -646,17 +646,17 @@ The ``--root-path`` option is added to all OCDS commands.
646646

647647
New library methods:
648648

649-
- :meth:`ocdskit.combine.package_releases`
650-
- :meth:`ocdskit.combine.combine_record_packages`
651-
- :meth:`ocdskit.combine.combine_release_packages`
652-
- :meth:`ocdskit.combine.compile_release_packages`
653-
- :meth:`ocdskit.mapping_sheet.mapping_sheet`
654-
- :meth:`ocdskit.schema.get_schema_fields`
649+
- :func:`ocdskit.combine.package_releases`
650+
- :func:`ocdskit.combine.combine_record_packages`
651+
- :func:`ocdskit.combine.combine_release_packages`
652+
- :func:`ocdskit.combine.compile_release_packages`
653+
- :func:`ocdskit.mapping_sheet.mapping_sheet`
654+
- :func:`ocdskit.schema.get_schema_fields`
655655

656656
Changed
657657
~~~~~~~
658658

659-
- **Backwards-incompatible**: :meth:`ocdskit.upgrade.upgrade_10_10`, :meth:`ocdskit.upgrade.upgrade_11_11` and :meth:`ocdskit.upgrade.upgrade_10_11` now return data, instead of only editing in-place.
659+
- **Backwards-incompatible**: :func:`ocdskit.upgrade.upgrade_10_10`, :func:`ocdskit.upgrade.upgrade_11_11` and :func:`ocdskit.upgrade.upgrade_10_11` now return data, instead of only editing in-place.
660660
- **Backwards-incompatible**: :ref:`mapping-sheet` and :ref:`schema-report` now read a file argument instead of standard input, to support schema that ``$ref`` other schema.
661661
- :ref:`mapping-sheet` and :ref:`schema-report` support schema from: Open Contracting for Infrastructure Data Standard (OC4IDS), Beneficial Ownership Data Standard (BODS), and Social Investment Data Lab Specification (SEDL).
662662
- :ref:`mapping-sheet` outputs:

0 commit comments

Comments
 (0)