Skip to content

Commit df596cb

Browse files
author
Alex Rozumey
committed
Merge branch 'master' of github.com:mimimi/ruby-tsv
2 parents df43bdd + 372ef0f commit df596cb

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ Or install it yourself as:
3232
`TSV.parse_file` accepts path to TSV file, returning lazy enumerator, yielding TSV::Row objects on demand
3333
`TSV.parse_file` is also aliased as `[]`, allowing for `TSV[filename]` syntax
3434

35+
#### TSV::Cyclist
36+
37+
While TSV specification requires headers, popular use doesn't necessarily adhere. In order to cope both `TSV::parse` and `TSV::parse_file` return Cyclist objects, that apart from acting as enumerators expose two additional methods: `#with_headers` and `#without_headers`. Neither method preserves read position by design.
38+
3539
#### TSV::Row
3640

3741
By default TSV::Row behaves like an Array of strings, derived from TSV row. However this similarity is limited to Enumerable methods. In case a real array is needed, `#to_a` will behave as expected.

0 commit comments

Comments
 (0)