Skip to content

Commit

Permalink
Improve match documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
edemaine committed Aug 10, 2022
1 parent 7209f6b commit bf7c223
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,8 @@ the following properties:
column `j + dj`. (Note the reversal of coordinates, so that the order
passed to `neighbor` corresponds to *x* then *y* coordinate.)
If there is no symbol at that position, you will still get a `Context`
whose `key` value is `null` and whose `includes()` always returns `false`.
whose `key` value is `null` and whose `includes()` and `match()`
always return `false`.
* In particular, it's really useful to call e.g.
`this.neighbor(1, 0).includes('-')` to check for adjacent symbols that
change how this symbol should be rendered.
Expand Down

0 comments on commit bf7c223

Please sign in to comment.