Skip to content

Commit

Permalink
docs(csvformat): Document new option, #1232
Browse files Browse the repository at this point in the history
  • Loading branch information
jpmckinney committed Feb 15, 2024
1 parent c874ebe commit 3b78663
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ Release process
#. All tests pass on continuous integration
#. The changelog is up-to-date and dated
#. If new options are added, regenerate the usage information in the documentation with, for example:

.. code-block:: bash
stty cols 80
csvformat -h
stty sane
#. The version number is correct in:

- setup.py
Expand Down
8 changes: 6 additions & 2 deletions docs/scripts/csvformat.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,9 @@ Convert a CSV file to a custom output format.:
usage: csvformat [-h] [-d DELIMITER] [-t] [-q QUOTECHAR] [-u {0,1,2,3}] [-b]
[-p ESCAPECHAR] [-z FIELD_SIZE_LIMIT] [-e ENCODING] [-S] [-H]
[-K SKIP_LINES] [-v] [-l] [--zero] [-V] [-E]
[-D OUT_DELIMITER] [-T] [-Q OUT_QUOTECHAR] [-U {0,1,2,3}]
[-B] [-P OUT_ESCAPECHAR] [-M OUT_LINETERMINATOR]
[-D OUT_DELIMITER] [-T] [-A] [-Q OUT_QUOTECHAR]
[-U {0,1,2,3}] [-B] [-P OUT_ESCAPECHAR]
[-M OUT_LINETERMINATOR]
[FILE]
Convert a CSV file to a custom output format.
Expand All @@ -29,6 +30,9 @@ Convert a CSV file to a custom output format.:
Delimiting character of the output file.
-T, --out-tabs Specify that the output file is delimited with tabs.
Overrides "-D".
-A, --out-asv Specify that the output file is delimited with the
ASCII unit separator and record separator. Overrides
"-T", "-D" and "-M".
-Q OUT_QUOTECHAR, --out-quotechar OUT_QUOTECHAR
Character used to quote strings in the output file.
-U {0,1,2,3}, --out-quoting {0,1,2,3}
Expand Down

0 comments on commit 3b78663

Please sign in to comment.