From c8d4149159f1977326422df4f3b1243dd9a3eb9a Mon Sep 17 00:00:00 2001 From: Peter Cock Date: Fri, 21 Sep 2018 11:54:59 +0100 Subject: [PATCH] Bullets not a literal block; don't indent bullets The first bullet list was wrongly preceded by a double colon meaning it was rendered as a literal block. Separately all the bullet lists were needlessly indented, which on GitHub causes them to be rendered with a distracting grey sidebar. --- README.rst | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index 67b5d1b..0d926c5 100644 --- a/README.rst +++ b/README.rst @@ -25,22 +25,22 @@ object and acts as a reader:: This produces a great deal of information, but it is conveniently accessed. -The attributes of a Record are the 8 fixed fields from the VCF spec:: +The attributes of a Record are the 8 fixed fields from the VCF spec: - * ``Record.CHROM`` - * ``Record.POS`` - * ``Record.ID`` - * ``Record.REF`` - * ``Record.ALT`` - * ``Record.QUAL`` - * ``Record.FILTER`` - * ``Record.INFO`` +* ``Record.CHROM`` +* ``Record.POS`` +* ``Record.ID`` +* ``Record.REF`` +* ``Record.ALT`` +* ``Record.QUAL`` +* ``Record.FILTER`` +* ``Record.INFO`` plus attributes to handle genotype information: - * ``Record.FORMAT`` - * ``Record.samples`` - * ``Record.genotype`` +* ``Record.FORMAT`` +* ``Record.samples`` +* ``Record.genotype`` ``samples`` and ``genotype``, not being the title of any column, are left lowercase. The format of the fixed fields is from the spec. Comma-separated lists in the VCF are @@ -115,11 +115,11 @@ There are also a number of methods:: Metadata regarding the VCF file itself can be investigated through the following attributes: - * ``Reader.metadata`` - * ``Reader.infos`` - * ``Reader.filters`` - * ``Reader.formats`` - * ``Reader.samples`` +* ``Reader.metadata`` +* ``Reader.infos`` +* ``Reader.filters`` +* ``Reader.formats`` +* ``Reader.samples`` For example::