Document that position is counted in chars not bytes

Issue #177

Signed-off-by: Michal Čihař <michal@cihar.com>

1 files changed, 3 insertions, 0 deletions

diff --git a/src/Token.php b/src/Token.php
index c3bdc19..4d028bf 100644
--- a/src/Token.php
+++ b/src/Token.php
@@ -207,6 +207,9 @@ class Token
     /**
      * The position in the initial string where this token started.
      *
+     * The position is counted in chars, not bytes, so you should
+     * use mb_* functions to properly handle utf-8 multibyte chars.
+     *
      * @var int
      */
     public $position;