steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

lexer: cleanup docs for $slots.

master
John Benediktsson 2020-05-27 09:47:38 -07:00
parent 10e19a3944
commit 3ee93ee68d
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
core/lexer/lexer-docs.factor
View File

@ -5,10 +5,10 @@ IN: lexer
HELP: lexer
{ $var-description "Stores the current " { $link lexer } " instance." }
{ $class-description "An object for tokenizing parser input. It has the following slots:"
{ $list
{ { $snippet "text" } " - the lines being parsed; an array of strings" }
{ { $snippet "line" } " - the line number being parsed; unlike most indices this is 1-based for friendlier error reporting and integration with text editors" }
{ { $snippet "column" } " - the current column position, zero-based" }
{ $slots
{ "text" "the lines being parsed; an array of strings" }
{ "line" "the line number being parsed; unlike most indices this is 1-based for friendlier error reporting and integration with text editors" }
{ "column" "the current column position, zero-based" }
}
"Custom lexing can be implemented by delegating a tuple to an instance of this class and implementing the " { $link skip-word } " and " { $link skip-blank } " generic words." } ;