From b2ea178bf873e4ff45b212355bc27304d23d06dd Mon Sep 17 00:00:00 2001 From: Nick Cameron Date: Tue, 20 Dec 2016 16:59:40 +1300 Subject: [PATCH] Revise note on toml files --- text/0000-customisability.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/text/0000-customisability.md b/text/0000-customisability.md index 3202403..e39f9a2 100644 --- a/text/0000-customisability.md +++ b/text/0000-customisability.md @@ -13,16 +13,22 @@ encouraged. # Details [details]: #details -Users may create a `rustfmt.toml` or `.rustfmt.toml` in their project directory -or any parent of that directory. Rustfmt will read options from the first toml -file (scanning up the directory tree). If an option is not present in the file, -Rustfmt uses the default option (as specified by the code style process RFCs). -The set of options available is not specified at this time. +A formatter such as Rustfmt may be customised by the user. These customisations +may be saved for a project using a cusomtisation file. For example, Rustfmt can +be customised by either a `rustfmt.toml` or `.rustfmt.toml` in their project +directory or any parent of that directory. Rustfmt will read options from the +first toml file (scanning up the directory tree). If an option is not present in +the file, Rustfmt uses the default option (as specified by the code style +process RFCs). The set of options available is not specified at this time; it +will be part of the style RFC process to enumerate them. + +A formatting tool may be customised in other ways, but must stick to the options +and defaults specified by the style RFCs. Customisation will be documented, but explicitly discouraged. All official Rust projects which use Rustfmt *must* use the default style and -*must not* include a `rustfmt.toml`. +*must not* include a customisation file. # Implementation [implementation]: #implementation