rust-guide icon indicating copy to clipboard operation
rust-guide copied to clipboard

Rules shall enforce things

Open xbonnetain opened this issue 5 years ago • 1 comments
trafficstars

Rule 5 is currently written as a suggestion:

The tool rustfmt can be used to ensure...

This is the only rule written this way, and it defeats its purpose.

This PR changes "can" to "must".

Other approaches

There are other possibilities, for example:

  • Removing this rule
  • Adding a "Suggestion/Best practice" block for non-mandatory things

xbonnetain avatar Jun 27 '20 20:06 xbonnetain

Forcing the usage of a specific formatter feels contrived, though. Maybe "an autoformatting tool (e.g. rustfmt) must be used". This way the phrasing remains open to alternative formatters that may arise.

danielhenrymantilla avatar Jun 28 '20 16:06 danielhenrymantilla