Skip to content

Commit 2f9d50d

Browse files
TimD1jmarshall
authored andcommitted
Minor documentation wordsmithing and alphabetising [trivial]
1 parent 5ac440f commit 2f9d50d

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

doc/api.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ To use the module to read a file in BAM format, create a
1515
import pysam
1616
samfile = pysam.AlignmentFile("ex1.bam", "rb")
1717

18-
Once a file is opened you can iterate over all of the read mapping to
18+
Once a file is opened you can iterate over all of the reads mapping to
1919
a specified region using :meth:`~pysam.AlignmentFile.fetch`. Each
2020
iteration returns a :class:`~pysam.AlignedSegment` object which
2121
represents a single read along with its fields and optional tags::
@@ -103,7 +103,7 @@ tabix indexed tab-separated file formats with genomic data::
103103
:class:`~pysam.TabixFile` implements lazy parsing in order to iterate
104104
over large tables efficiently.
105105

106-
More detailed usage instructions is at :ref:`usage`.
106+
More detailed usage instructions are available at :ref:`usage`.
107107

108108
.. note::
109109

@@ -200,7 +200,6 @@ FASTQ files
200200
.. autoclass:: pysam.FastxFile
201201
:members:
202202

203-
204203
.. autoclass:: pysam.FastqProxy
205204
:members:
206205

@@ -214,10 +213,10 @@ VCF/BCF files
214213
.. autoclass:: pysam.VariantHeader
215214
:members:
216215

217-
.. autoclass:: pysam.VariantRecord
216+
.. autoclass:: pysam.VariantHeaderRecord
218217
:members:
219218

220-
.. autoclass:: pysam.VariantHeaderRecord
219+
.. autoclass:: pysam.VariantRecord
221220
:members:
222221

223222
HTSFile

0 commit comments

Comments
 (0)