Skip to content

add section saying that code inside macro should be formatted #13163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ShahakShama wants to merge 1 commit into from
Closed

add section saying that code inside macro should be formatted #13163

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions style.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -457,6 +457,14 @@ Only use macros if non-macro alternatives are not feasible and when _really_ nec

For example: using parametrization in a test (using rstest) can make tests harder to reason about and debug in some cases, when the parametrization is very complicated and involves complex types. In those cases one should consider a free-function that performs the test, and several one-line tests that call it with different args, rather than forcing a parameterized solution.

#### Formatting Macros

`rustfmt` does not format code inside macro invocations.
This applies to any macro that contains Rust code, such as `stream!`, `indexmap!`.
Make sure the code inside the macro is formatted correctly.

**Tip**: Temporarily copy the code outside of the macro, run `rustfmt`, and then copy it back.

### If-let-else Pattern

Prefer `let-else` or `match` patterns, they are always more concise and incur less cognitive load
Expand Down
Loading