From 55312f29723b4f2b493e677ac644abf8971b4dca Mon Sep 17 00:00:00 2001 From: "Tobin C. Harding" Date: Thu, 21 Jul 2022 09:33:02 +1000 Subject: [PATCH] Update contributing docs re cargo fmt Now that we use `cargo fmt`, update the section in the contributing documentation. --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9e75f36a..578da83f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -170,9 +170,9 @@ Library reflects Bitcoin Core approach whenever possible. ### Formatting -The repository currently does use `rustfmt`. The introduction of this is still -WIP (see 'ignore' in `rustfmt.toml`) but we are working towards full -formatting. +The repository currently uses `rustfmt` (WIP, some directories are excluded). We use nightly +features so to run the formatter use `cargo +nightly fmt`. (Remember that your editor may be +configured to fmt with a stable toolchain, this will result in many unwanted changes.) ### Naming conventions