Skip to content

Commit 3f2aaf8

Browse files
committed
Rearrange Variant* class documentation
1 parent 8a96ea0 commit 3f2aaf8

1 file changed

Lines changed: 16 additions & 9 deletions

File tree

doc/api.rst

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -213,28 +213,37 @@ VCF/BCF files
213213
.. autoclass:: pysam.VariantHeader
214214
:members:
215215

216-
.. autoclass:: pysam.VariantHeaderMetadata
216+
.. autoclass:: pysam.VariantRecord
217217
:members:
218218

219-
.. autoclass:: pysam.VariantMetadata
219+
.. autoclass:: pysam.VariantContig
220220
:members:
221221

222-
.. autoclass:: pysam.VariantHeaderRecords
222+
.. autoclass:: pysam.VariantHeaderRecord
223223
:members:
224224

225-
.. autoclass:: pysam.VariantHeaderRecord
225+
.. autoclass:: pysam.VariantMetadata
226+
:members:
227+
228+
.. autoclass:: pysam.VariantRecordSample
226229
:members:
227230

231+
Internal classes
232+
----------------
233+
234+
These classes are used internally to represent particular header and record
235+
fields. They cannot be instantiated directly in your Python or Cython code.
236+
228237
.. autoclass:: pysam.VariantHeaderContigs
229238
:members:
230239

231-
.. autoclass:: pysam.VariantContig
240+
.. autoclass:: pysam.VariantHeaderMetadata
232241
:members:
233242

234-
.. autoclass:: pysam.VariantHeaderSamples
243+
.. autoclass:: pysam.VariantHeaderRecords
235244
:members:
236245

237-
.. autoclass:: pysam.VariantRecord
246+
.. autoclass:: pysam.VariantHeaderSamples
238247
:members:
239248

240249
.. autoclass:: pysam.VariantRecordFilter
@@ -249,8 +258,6 @@ VCF/BCF files
249258
.. autoclass:: pysam.VariantRecordSamples
250259
:members:
251260

252-
.. autoclass:: pysam.VariantRecordSample
253-
:members:
254261

255262
HTSFile
256263
=======

0 commit comments

Comments
 (0)