Skip to content

Commit 79d629e

Browse files
committed
Update changelog
1 parent 91bbdc8 commit 79d629e

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

docs/changelog.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,12 @@ New Features
1414
- Add 'matching' method to :func:`identity_by_state` function.
1515
(:user:`timothymillar`, :pr:`1229`, :issue:`1227`)
1616

17-
.. Breaking changes
18-
.. ~~~~~~~~~~~~~~~~
17+
Breaking changes
18+
~~~~~~~~~~~~~~~~
19+
20+
- Functions for reading and writing VCF were removed from sgkit, please use the `bio2zarr <https://github.com/sgkit-dev/bio2zarr>`_
21+
and `vcztools <https://github.com/sgkit-dev/vcztools>`_ packages instead.
22+
(:user:`tomwhite`, :pr:`1264`)
1923

2024
.. Deprecations
2125
.. ~~~~~~~~~~~~
@@ -147,22 +151,22 @@ New Features
147151
- Add :func:`sgkit.convert_call_to_index` method.
148152
(:user:`timothymillar`, :pr:`1050`, :issue:`1048`)
149153

150-
- Add ``read_chunk_length`` option to :func:`sgkit.io.vcf.vcf_to_zarr` and
151-
:func:`sgkit.io.vcf.vcf_to_zarrs` functions. These are useful to reduce memory usage
154+
- Add ``read_chunk_length`` option to ``sgkit.io.vcf.vcf_to_zarr`` and
155+
``sgkit.io.vcf.vcf_to_zarrs`` functions. These are useful to reduce memory usage
152156
with large sample counts or a large ``chunk_length``.
153157
(:user:`benjeffery`, :pr:`1044`, :issue:`1042`)
154158

155-
- Add ``retain_temp_files`` to :func:`sgkit.io.vcf.vcf_to_zarr` function.
159+
- Add ``retain_temp_files`` to ``sgkit.io.vcf.vcf_to_zarr`` function.
156160
(:user:`benjeffery`, :pr:`1046`, :issue:`1036`)
157161

158-
- Add :func:`sgkit.io.vcf.read_vcf` convenience function.
162+
- Add ``sgkit.io.vcf.read_vcf`` convenience function.
159163
(:user:`tomwhite`, :pr:`1052`, :issue:`1004`)
160164

161165
- Add :func:`sgkit.hybrid_relationship`, :func:`sgkit.hybrid_inverse_relationship`
162166
and :func:`invert_relationship_matrix` methods.
163167
(:user:`timothymillar`, :pr:`1053`, :issue:`993`)
164168

165-
- Add :func:`sgkit.io.vcf.zarr_array_sizes` for determining array sizes for storage in Zarr.
169+
- Add ``sgkit.io.vcf.zarr_array_sizes`` for determining array sizes for storage in Zarr.
166170
(:user:`tomwhite`, :pr:`1073`, :issue:`734`)
167171

168172
- Add ``skipna`` option to :func:`genomic_relationship` function.
@@ -174,7 +178,7 @@ New Features
174178
Breaking changes
175179
~~~~~~~~~~~~~~~~
176180

177-
- Generate VCF header by default when writing VCF using :func:`sgkit.io.vcf.write_vcf` or :func:`sgkit.io.vcf.zarr_to_vcf`.
181+
- Generate VCF header by default when writing VCF using ``sgkit.io.vcf.write_vcf`` or ``sgkit.io.vcf.zarr_to_vcf``.
178182
Previously, the dataset had to contain a ``vcf_header`` attribute.
179183
(:user:`tomwhite`, :pr:`1021`, :issue:`1020`)
180184

0 commit comments

Comments
 (0)