Skip to content

Commit e956149

Browse files
hyanwongbenjeffery
authored andcommitted
Fix formatting and typos in CHANGELOG.rst
1 parent 20d630b commit e956149

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

python/CHANGELOG.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
**Breaking Changes**
66

7-
- `TreeSequence.tables` now returns a zero-copy immutable view of the tables.
8-
To get a mutable copy, use `TreeSequence.dump_tables()`.
7+
- ``TreeSequence.tables`` now returns a zero-copy immutable view of the tables.
8+
To get a mutable copy, use ``TreeSequence.dump_tables()``.
99
(:user:`benjeffery`, :pr:`3288`, :issue:`760`)
1010

11-
- For a tree seqeunce to be valid mutation parents in the table collection
11+
- For a tree sequence to be valid mutation parents in the table collection
1212
must be correct and consistent with the topology of the tree at each mutation site.
1313
``TableCollection.tree_sequence()`` will raise a ``_tskit.LibraryError`` if this
1414
is not the case.
@@ -52,9 +52,9 @@
5252

5353
**Bugfixes**
5454

55-
- In some tables with mutations out-of-order `TableCollection.sort` did not re-order
56-
the mutations so they formed a valid TreeSequence. `TableCollection.sort` and
57-
`TableCollection.canonicalise` now sort mutations by site, then time (if known),
55+
- In some tables with mutations out-of-order ``TableCollection.sort`` did not re-order
56+
the mutations so they formed a valid TreeSequence. ``TableCollection.sort`` and
57+
``TableCollection.canonicalise`` now sort mutations by site, then time (if known),
5858
then the mutation's node's time, then number of descendant mutations
5959
(ensuring that parent mutations occur before children), then node, then
6060
their original order in the tables. (:user:`benjeffery`, :pr:`3257`, :issue:`3253`)
@@ -68,7 +68,7 @@
6868
(:user:`benjeffery`, :pr:`3246`, :issue:`3244`)
6969

7070
- k-way statistics no longer require k sample sets, allowing in particular
71-
"self" comparisons for `TreeSequence.genetic_relatedness`. This changes the
71+
"self" comparisons for ``TreeSequence.genetic_relatedness``. This changes the
7272
error code returned in some situations.
7373
(:user:`andrewkern`, :user:`petrelharp`, :pr:`3235`, :issue:`3055`)
7474

@@ -107,6 +107,7 @@
107107
- Add ``TreeSequence.map_to_vcf_model`` method to return a mapping of
108108
the tree sequence to the VCF model.
109109
(:user:`benjeffery`, :pr:`3163`)
110+
110111
- Use a thin space as the thousands separator in HTML output,
111112
and a comma in CLI output.
112113
(:user:`hossam26644`, :pr:`3167`, :issue:`2951`)

0 commit comments

Comments
 (0)