Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
wdavidw committed Jul 30, 2013
1 parent 3748385 commit 05db365
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
6 changes: 3 additions & 3 deletions doc/from.md
Expand Up @@ -2,7 +2,7 @@
language: en
layout: page
title: "Reading data from a source"
date: 2013-07-17T08:03:53.224Z
date: 2013-07-30T09:03:48.121Z
comments: false
sharing: false
footer: false
Expand All @@ -21,8 +21,8 @@ here are two identical ways to read from a file:

```javascript

csv.from('/tmp/data.csv').on('data', console.log);
csv.from.path('/tmp/data.csv').on('data', console.log);
csv().from('/tmp/data.csv').on('data', console.log);
csv().from.path('/tmp/data.csv').on('data', console.log);
```


Expand Down
4 changes: 2 additions & 2 deletions doc/to.md
Expand Up @@ -2,7 +2,7 @@
language: en
layout: page
title: "Writing data to a destination"
date: 2013-07-17T08:03:53.224Z
date: 2013-07-30T09:03:48.121Z
comments: false
sharing: false
footer: false
Expand Down Expand Up @@ -68,7 +68,7 @@ as an object if no argument is provided.
* `quote` Defaults to the quote read option.
* `quoted` Boolean, default to false, quote all the fields even if not required.
* `escape` Defaults to the escape read option.
* `columns` List of fields, applied when `transform` returns an object, order matters, see the transform and the columns sections below.
* `columns` List of fields, applied when `transform` returns an object, order matters, read the transformer documentation for additionnal information.
* `header` Display the column names on the first line if the columns option is provided.
* `lineBreaks` String used to delimit record rows or a special value; special values are 'auto', 'unix', 'mac', 'windows', 'unicode'; defaults to 'auto' (discovered in source or 'unix' if no source is specified).
* `flags` Defaults to 'w', 'w' to create or overwrite an file, 'a' to append to a file. Applied when using the `toPath` method.
Expand Down
4 changes: 2 additions & 2 deletions lib/from.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions src/from.coffee
Expand Up @@ -17,8 +17,8 @@ a buffer or a readable stream.
You may call the `from` function or one of its sub function. For example,
here are two identical ways to read from a file:
csv.from('/tmp/data.csv').on('data', console.log);
csv.from.path('/tmp/data.csv').on('data', console.log);
csv().from('/tmp/data.csv').on('data', console.log);
csv().from.path('/tmp/data.csv').on('data', console.log);
###
module.exports = (csv) ->
Expand Down

0 comments on commit 05db365

Please sign in to comment.