aboutsummaryrefslogtreecommitdiffstats
path: root/docs/using_as_module.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2011-08-03 13:57:18 -0400
committerWaylan Limberg <waylan@gmail.com>2011-08-03 13:57:18 -0400
commit362782d1e08089c74f5bfcf0937ace4fa5b49eea (patch)
tree136fc3eba404708c9f414816ac5c703dec2bdf5e /docs/using_as_module.txt
parent9b51cc6aab4bbb18b925328e5d918fa56a5931e2 (diff)
downloadmarkdown-362782d1e08089c74f5bfcf0937ace4fa5b49eea.tar.gz
markdown-362782d1e08089c74f5bfcf0937ace4fa5b49eea.tar.bz2
markdown-362782d1e08089c74f5bfcf0937ace4fa5b49eea.zip
Markdown.convertFile now actually works with stdin and stdout. Previously only the commandline script did.
Diffstat (limited to 'docs/using_as_module.txt')
-rw-r--r--docs/using_as_module.txt5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/using_as_module.txt b/docs/using_as_module.txt
index f50a0ec..662affd 100644
--- a/docs/using_as_module.txt
+++ b/docs/using_as_module.txt
@@ -167,10 +167,11 @@ the following required options:
* `input` (required): The source text file.
- `input` may be set to one of two options:
+ `input` may be set to one of three options:
* a string which contains a path to a readable file on the file system,
- * or a readable file-like object.
+ * a readable file-like object,
+ * or `None` (default) which will read from `stdin`.
* `output`: The target which output to written to.