Skip to content

Rust: document rustfmt macro preservation #205

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
wants to merge 1 commit into from
Closed

Rust: document rustfmt macro preservation #205

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
3 changes: 3 additions & 0 deletions Documentation/rust/coding.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ good news!
.. note:: Conventions on comments and documentation are not checked by
``rustfmt``. Thus we still need to take care of those: please see
:ref:`Documentation/rust/docs.rst <rust_docs>`.

.. note:: `rustfmt` also preserves formatting inside most macros. So you might
need to manually adjust newlines and indents inside macro invocations.

We use the tool's default settings. This means we are following the idiomatic
Rust style. For instance, we use 4 spaces for indentation rather than tabs.
Expand Down