Skip to content

Commit

Permalink
Doc for separator option in readers.text.
Browse files Browse the repository at this point in the history
Close #1630
  • Loading branch information
abellgithub committed Jul 28, 2017
1 parent a481a28 commit da33e89
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/stages/readers.text.rst
Expand Up @@ -11,7 +11,8 @@ C++ language double-precision values.

The text reader expects a header line to 1) indicate the separator character
for the fields and 2) name the dimension for each field in the points. Any
single non-alphanumeric character can be used as a separator.
single non-alphanumeric character can be used as a separator. The header line
separator can be overridden by the 'separator' option (see below).
Each line in the file must contain the same number of fields as indicated by
dimension names in the header. Spaces are generally ignored in the input
unless used as a separator. When a space character is used as a separator,
Expand Down Expand Up @@ -62,4 +63,7 @@ Options
filename
text file to read [Required]

separator
Separator character to override that found in header line.

.. _formatted: http://en.cppreference.com/w/cpp/string/basic_string/stof

0 comments on commit da33e89

Please sign in to comment.