diff --git a/doc/argument_io.rdoc b/doc/csv/arguments/io.rdoc similarity index 100% rename from doc/argument_io.rdoc rename to doc/csv/arguments/io.rdoc diff --git a/doc/csv/col_sep.rdoc b/doc/csv/options/common/col_sep.rdoc similarity index 100% rename from doc/csv/col_sep.rdoc rename to doc/csv/options/common/col_sep.rdoc diff --git a/doc/csv/quote_char.rdoc b/doc/csv/options/common/quote_char.rdoc similarity index 100% rename from doc/csv/quote_char.rdoc rename to doc/csv/options/common/quote_char.rdoc diff --git a/doc/csv/row_sep.rdoc b/doc/csv/options/common/row_sep.rdoc similarity index 100% rename from doc/csv/row_sep.rdoc rename to doc/csv/options/common/row_sep.rdoc diff --git a/doc/csv/force_quotes.rdoc b/doc/csv/options/generating/force_quotes.rdoc similarity index 100% rename from doc/csv/force_quotes.rdoc rename to doc/csv/options/generating/force_quotes.rdoc diff --git a/doc/csv/quote_empty.rdoc b/doc/csv/options/generating/quote_empty.rdoc similarity index 100% rename from doc/csv/quote_empty.rdoc rename to doc/csv/options/generating/quote_empty.rdoc diff --git a/doc/csv/write_converters.rdoc b/doc/csv/options/generating/write_converters.rdoc similarity index 100% rename from doc/csv/write_converters.rdoc rename to doc/csv/options/generating/write_converters.rdoc diff --git a/doc/csv/write_empty_value.rdoc b/doc/csv/options/generating/write_empty_value.rdoc similarity index 100% rename from doc/csv/write_empty_value.rdoc rename to doc/csv/options/generating/write_empty_value.rdoc diff --git a/doc/csv/write_headers.rdoc b/doc/csv/options/generating/write_headers.rdoc similarity index 100% rename from doc/csv/write_headers.rdoc rename to doc/csv/options/generating/write_headers.rdoc diff --git a/doc/csv/write_nil_value.rdoc b/doc/csv/options/generating/write_nil_value.rdoc similarity index 100% rename from doc/csv/write_nil_value.rdoc rename to doc/csv/options/generating/write_nil_value.rdoc diff --git a/doc/csv/converters.rdoc b/doc/csv/options/parsing/converters.rdoc similarity index 100% rename from doc/csv/converters.rdoc rename to doc/csv/options/parsing/converters.rdoc diff --git a/doc/csv/empty_value.rdoc b/doc/csv/options/parsing/empty_value.rdoc similarity index 100% rename from doc/csv/empty_value.rdoc rename to doc/csv/options/parsing/empty_value.rdoc diff --git a/doc/csv/field_size_limit.rdoc b/doc/csv/options/parsing/field_size_limit.rdoc similarity index 100% rename from doc/csv/field_size_limit.rdoc rename to doc/csv/options/parsing/field_size_limit.rdoc diff --git a/doc/csv/header_converters.rdoc b/doc/csv/options/parsing/header_converters.rdoc similarity index 100% rename from doc/csv/header_converters.rdoc rename to doc/csv/options/parsing/header_converters.rdoc diff --git a/doc/csv/headers.rdoc b/doc/csv/options/parsing/headers.rdoc similarity index 100% rename from doc/csv/headers.rdoc rename to doc/csv/options/parsing/headers.rdoc diff --git a/doc/csv/liberal_parsing.rdoc b/doc/csv/options/parsing/liberal_parsing.rdoc similarity index 100% rename from doc/csv/liberal_parsing.rdoc rename to doc/csv/options/parsing/liberal_parsing.rdoc diff --git a/doc/csv/nil_value.rdoc b/doc/csv/options/parsing/nil_value.rdoc similarity index 100% rename from doc/csv/nil_value.rdoc rename to doc/csv/options/parsing/nil_value.rdoc diff --git a/doc/csv/return_headers.rdoc b/doc/csv/options/parsing/return_headers.rdoc similarity index 100% rename from doc/csv/return_headers.rdoc rename to doc/csv/options/parsing/return_headers.rdoc diff --git a/doc/csv/skip_blanks.rdoc b/doc/csv/options/parsing/skip_blanks.rdoc similarity index 100% rename from doc/csv/skip_blanks.rdoc rename to doc/csv/options/parsing/skip_blanks.rdoc diff --git a/doc/csv/skip_lines.rdoc b/doc/csv/options/parsing/skip_lines.rdoc similarity index 100% rename from doc/csv/skip_lines.rdoc rename to doc/csv/options/parsing/skip_lines.rdoc diff --git a/doc/csv/strip.rdoc b/doc/csv/options/parsing/strip.rdoc similarity index 100% rename from doc/csv/strip.rdoc rename to doc/csv/options/parsing/strip.rdoc diff --git a/doc/csv/unconverted_fields.rdoc b/doc/csv/options/parsing/unconverted_fields.rdoc similarity index 100% rename from doc/csv/unconverted_fields.rdoc rename to doc/csv/options/parsing/unconverted_fields.rdoc diff --git a/lib/csv.rb b/lib/csv.rb index 6e717667b7fb71..ef73bd0c8a43aa 100644 --- a/lib/csv.rb +++ b/lib/csv.rb @@ -251,55 +251,55 @@ # # === Options for Parsing # -# :include: ../doc/col_sep.rdoc +# :include: ../doc/options/common/col_sep.rdoc # -# :include: ../doc/row_sep.rdoc +# :include: ../doc/options/common/row_sep.rdoc # -# :include: ../doc/quote_char.rdoc +# :include: ../doc/options/common/quote_char.rdoc # -# :include: ../doc/field_size_limit.rdoc +# :include: ../doc/options/parsing/field_size_limit.rdoc # -# :include: ../doc/converters.rdoc +# :include: ../doc/options/parsing/converters.rdoc # -# :include: ../doc/unconverted_fields.rdoc +# :include: ../doc/options/parsing/unconverted_fields.rdoc # -# :include: ../doc/headers.rdoc +# :include: ../doc/options/parsing/headers.rdoc # -# :include: ../doc/return_headers.rdoc +# :include: ../doc/options/parsing/return_headers.rdoc # -# :include: ../doc/header_converters.rdoc +# :include: ../doc/options/parsing/header_converters.rdoc # -# :include: ../doc/skip_blanks.rdoc +# :include: ../doc/options/parsing/skip_blanks.rdoc # -# :include: ../doc/skip_lines.rdoc +# :include: ../doc/options/parsing/skip_lines.rdoc # -# :include: ../doc/liberal_parsing.rdoc +# :include: ../doc/options/parsing/strip.rdoc # -# :include: ../doc/nil_value.rdoc +# :include: ../doc/options/parsing/liberal_parsing.rdoc # -# :include: ../doc/empty_value.rdoc +# :include: ../doc/options/parsing/nil_value.rdoc # -# === Options for Generating +# :include: ../doc/options/parsing/empty_value.rdoc # -# :include: ../doc/col_sep.rdoc +# === Options for Generating # -# :include: ../doc/row_sep.rdoc +# :include: ../doc/options/common/col_sep.rdoc # -# :include: ../doc/quote_char.rdoc +# :include: ../doc/options/common/row_sep.rdoc # -# :include: ../doc/write_headers.rdoc +# :include: ../doc/options/common/quote_char.rdoc # -# :include: ../doc/force_quotes.rdoc +# :include: ../doc/options/generating/write_headers.rdoc # -# :include: ../doc/quote_empty.rdoc +# :include: ../doc/options/generating/force_quotes.rdoc # -# :include: ../doc/write_converters.rdoc +# :include: ../doc/options/generating/quote_empty.rdoc # -# :include: ../doc/write_nil_value.rdoc +# :include: ../doc/options/generating/write_converters.rdoc # -# :include: ../doc/write_empty_value.rdoc +# :include: ../doc/options/generating/write_nil_value.rdoc # -# :include: ../doc/strip.rdoc +# :include: ../doc/options/generating/write_empty_value.rdoc # # == CSV with headers # @@ -834,7 +834,7 @@ def filter(input=nil, output=nil, **options) # Returns an integer, or, if there were no rows, +nil+. # # * Argument +path+, if given, must be the path to a file. - # :include: ../doc/argument_io.rdoc + # :include: ../doc/arguments/io.rdoc # * Argument +mode+, if given, must be a \File mode # See {Open Mode}[IO.html#method-c-new-label-Open+Mode]. # * Arguments **options must be keyword options. @@ -1069,7 +1069,7 @@ def generate_line(row, **options) # :replace => string # replacement string ("?" or "\uFFFD" if not specified) # # * Argument +path+, if given, must be the path to a file. - # :include: ../doc/argument_io.rdoc + # :include: ../doc/arguments/io.rdoc # * Argument +mode+, if given, must be a \File mode # See {Open Mode}[IO.html#method-c-new-label-Open+Mode]. # * Arguments **options must be keyword options. @@ -1174,7 +1174,7 @@ def open(filename, mode="r", **options) # # - Argument +string+ should be a \String object; # it will be put into a new StringIO object positioned at the beginning. - # :include: ../doc/argument_io.rdoc + # :include: ../doc/arguments/io.rdoc # - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing] # # ====== Without Option +headers+ @@ -1300,7 +1300,7 @@ def parse(str, **options, &block) # # - Argument +string+ should be a \String object; # it will be put into a new StringIO object positioned at the beginning. - # :include: ../doc/argument_io.rdoc + # :include: ../doc/arguments/io.rdoc # - Argument +options+: see {Options for Parsing}[#class-CSV-label-Options+for+Parsing] # # ====== Without Option +headers+ @@ -1404,7 +1404,7 @@ def table(path, **options) # # - Argument +string+ should be a \String object; # it will be put into a new StringIO object positioned at the beginning. - # :include: ../doc/argument_io.rdoc + # :include: ../doc/arguments/io.rdoc # - Argument +options+: See: # * {Options for Parsing}[#class-CSV-label-Options+for+Parsing] # * {Options for Generating}[#class-CSV-label-Options+for+Generating]