Skip to content

Commit

Permalink
DOC: fix & tidy up _fill_match_cells() docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fedarko committed Sep 12, 2023
1 parent 2274382 commit a213e00
Showing 1 changed file with 6 additions and 9 deletions.
15 changes: 6 additions & 9 deletions wotplot/_make.py
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,11 @@ def _fill_match_cells(
Suffix array for (s2 + ENDCHAR).
md: dict of (int, int) --> int
We'll update this dict with keys of the format (p1, p2) (indicating
We'll update this dict with keys of the format (p2, p1) (indicating
that a matching k-mer exists at position p1 in s1 and position p2 in
s2). The match types (each one of {FWD, REV, BOTH, MATCH}) are given by
the values of this dict.
s2); these positions correspond to the (row, col) positions of match
cells in a matrix, taking into account yorder. The values of this dict
indicate match types (one of {FWD, REV, BOTH, MATCH}).
yorder: str
Either "BT" (bottom-to-top) or "TB" (top-to-bottom). See
Expand All @@ -137,12 +138,8 @@ def _fill_match_cells(
Returns
-------
matches: list of (int, int)
Each entry in this list is of the format (p2, p1), and corresponds to
the presence of a matching k-mer at position p1 in s1 and position p2
in s2. (Both p1 and p2 are zero-indexed.) This thus corresponds to the
(row, col) positions of match cells in a matrix, if s1 is on the
horizontal axis and s2 is on the vertical axis.
None
(The main "side effect" of this function is updating md; see above.)
Example
-------
Expand Down

0 comments on commit a213e00

Please sign in to comment.