Skip to content

Commit 7ce97cd

Browse files
committed
toml_config.rst: Add phase 2 docs
Documentation on ConfigConverter tool and toml support on coala-quickstart. Closes #597
1 parent 8d05638 commit 7ce97cd

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

Users/coala_quickstart.rst

+14
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,17 @@ root:
6969
::
7070

7171
$ coala
72+
73+
coala-quickstart can also generate configuration files in TOML.
74+
To generate a configuration file in TOML use
75+
76+
::
77+
78+
$ coala-quickstart - T
79+
80+
Once you have completed these steps just execute coala from your project's
81+
root:
82+
83+
::
84+
85+
$ coala -T

Users/toml_config.rst

+23
Original file line numberDiff line numberDiff line change
@@ -356,3 +356,26 @@ Using the above rules we get a configuration file in TOML
356356
appends = 'bears'
357357
language = 'Python'
358358
remove_all_unused_imports = true
359+
360+
Configuration Converter Tool
361+
-----------------------------
362+
363+
coala provides a tool to convert a coafile to a TOML file and vice
364+
versa. You can use it by running
365+
366+
::
367+
368+
$ coala -cc input_file output_file
369+
370+
371+
-cc is short for --config-converter. It requires two arguments,
372+
input configuration file and output configuration file.
373+
374+
For example
375+
376+
::
377+
378+
$ coala -cc .coafile .coafile.toml
379+
380+
381+
generates .coafile.toml from .coafile

0 commit comments

Comments
 (0)