summaryrefslogtreecommitdiff
path: root/docs/src
diff options
context:
space:
mode:
authorgbrandl <devnull@localhost>2006-12-01 15:20:35 +0100
committergbrandl <devnull@localhost>2006-12-01 15:20:35 +0100
commit4113a2202daa90c056a9bc8a9c1e1ab8d4abca7c (patch)
tree6e060f55b437a10d2470eabb165c9cd8a0c00482 /docs/src
parenteacc98529bcfc9a6139321d2fd9e68bb076f1fa8 (diff)
downloadpygments-4113a2202daa90c056a9bc8a9c1e1ab8d4abca7c.tar.gz
[svn] Fix some doc errors spotted by Tim Hatch.
Diffstat (limited to 'docs/src')
-rw-r--r--docs/src/installation.txt2
-rw-r--r--docs/src/lexerdevelopment.txt28
2 files changed, 24 insertions, 6 deletions
diff --git a/docs/src/installation.txt b/docs/src/installation.txt
index 39305f21..a88ae135 100644
--- a/docs/src/installation.txt
+++ b/docs/src/installation.txt
@@ -5,7 +5,7 @@ Installation
============
Pygments requires at least Python 2.3 to work correctly. Just to clarify:
-there *wont't* ever be support for Python versions below 2.3.
+there *won't* ever be support for Python versions below 2.3.
Install the Release Version
diff --git a/docs/src/lexerdevelopment.txt b/docs/src/lexerdevelopment.txt
index d3157fe4..31a884e8 100644
--- a/docs/src/lexerdevelopment.txt
+++ b/docs/src/lexerdevelopment.txt
@@ -52,8 +52,7 @@ functions.
.. sourcecode:: python
from pygments.lexer import RegexLexer
- from pygments.token import \
- Text, Comment, Keyword, Name, String, Generic
+ from pygments.token import *
class DiffLexer(RegexLexer):
name = 'Diff'
@@ -104,6 +103,7 @@ sections, comments and key = value pairs:
.. sourcecode:: python
from pygments.lexer import RegexLexer, bygroups
+ from pygments.token import *
class IniLexer(RegexLexer):
name = 'INI'
@@ -124,7 +124,7 @@ The lexer first looks for whitespace, comments and section names. And later it
looks for a line that looks like a key, value pair, seperated by an ``'='``
sign, and optional whitespace.
-The `bygroups` helper makes sure that aach group is yielded with a different
+The `bygroups` helper makes sure that each group is yielded with a different
token type. First the `Name.Attribute` token, then a `Text` token for the
optional whitespace, after that a `Operator` token for the equals sign. Then a
`Text` token for the whitespace again. The rest of the line is returned as
@@ -147,6 +147,9 @@ Here is the solution:
.. sourcecode:: python
+ from pygments.lexer import RegexLexer
+ from pygments.token import *
+
class ExampleLexer(RegexLexer):
name = 'Example Lexer with states'
@@ -234,7 +237,8 @@ There are a few more things you can do with states:
.. sourcecode:: python
- from pygments.lexer import RegexLexer, include
+ from pygments.lexer import RegexLexer, bygroups, include
+ from pygments.token import *
class ExampleLexer(RegexLexer):
tokens = {
@@ -245,7 +249,7 @@ There are a few more things you can do with states:
'root': [
include('comments'),
(r'(function )(\w+)( {)',
- (Keyword, Name, Keyword), 'function'),
+ bygroups(Keyword, Name, Keyword), 'function'),
(r'.', Text),
],
'function': [
@@ -279,6 +283,8 @@ There are a few more things you can do with states:
.. sourcecode:: python
+ from pygments.lexer import RegexLexer
+
class MyLexer(RegexLexer):
tokens = {...}
@@ -306,6 +312,8 @@ For example, look at this stripped-down HTML lexer:
.. sourcecode:: python
from pygments.lexer import RegexLexer, bygroups, using
+ from pygments.token import *
+ from pygments.lexers.web import JavascriptLexer
class HtmlLexer(RegexLexer):
name = 'HTML'
@@ -406,9 +414,14 @@ You can see an example here:
.. sourcecode:: python
+ from pygments.lexer import RegexLexer
+ from pygments.token import Generic
+
class HypotheticLexer(RegexLexer):
def headline_callback(lexer, match):
+ equal_signs = match.group(1)
+ text = match.group(2)
yield match.start(), Generic.Headline, equal_signs + text + equal_signs
tokens = {
@@ -464,9 +477,14 @@ For example, this is how the hypothetical lexer above would be written with the
.. sourcecode:: python
+ from pygments.lexer import ExtendedRegexLexer
+ from pygments.token import Generic
+
class ExHypotheticLexer(ExtendedRegexLexer):
def headline_callback(lexer, match, ctx):
+ equal_signs = match.group(1)
+ text = match.group(2)
yield match.start(), Generic.Headline, equal_signs + text + equal_signs
ctx.pos = match.end()