diff options
| author | gbrandl <devnull@localhost> | 2006-12-20 21:21:37 +0100 |
|---|---|---|
| committer | gbrandl <devnull@localhost> | 2006-12-20 21:21:37 +0100 |
| commit | bc6d85124f16c0e62c8fa1d2f3f117b929a6ff4a (patch) | |
| tree | 8b6c87734f97826489a744b0b4c64b8080285361 /docs/src | |
| parent | 1d634b6950bfac268f6d05a673fd48094738f01e (diff) | |
| download | pygments-bc6d85124f16c0e62c8fa1d2f3f117b929a6ff4a.tar.gz | |
[svn] Clarify docs and remove debugging code.
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/formatters.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/src/formatters.txt b/docs/src/formatters.txt index b4d8dc65..4eb64e7d 100644 --- a/docs/src/formatters.txt +++ b/docs/src/formatters.txt @@ -24,6 +24,11 @@ All formatters support this option: If this is ``""`` or ``None``, Unicode strings will be written to the output file, which most file-like objects do not support. + For example, `pygments.highlight()` will return a Unicode string if + called with no `outfile` argument and a formatter that has `encoding` + set to ``None`` because it uses a `StringIO.StringIO` object that + supports Unicode arguments to `write()`. Using a regular file object + wouldn't work. The `HtmlFormatter` and `LatexFormatter` classes support these options: |