Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Better formatting for doc comments #8030

Merged

Conversation

JoshOrndorff
Copy link
Contributor

This PR changes the whitespace in a doc comment. Clippy was complaining about this as follows:

  error: using tabs in doc comments is not recommended
    --> /home/joshy/.cargo/git/checkouts/substrate-7e08433d4c370a21/f977fb8/primitives/debug-derive/src/lib.rs:30:4
     |
  30 | //!    struct MyStruct;
     |    ^^^^ help: consider using four spaces per tab
     |
     = note: `-D clippy::tabs-in-doc-comments` implied by `-D warnings`
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments

  error: using tabs in doc comments is not recommended
    --> /home/joshy/.cargo/git/checkouts/substrate-7e08433d4c370a21/f977fb8/primitives/debug-derive/src/lib.rs:32:4
     |
  32 | //!    assert_eq!(format!("{:?}", MyStruct), "MyStruct");
     |    ^^^^ help: consider using four spaces per tab
     |
     = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#tabs_in_doc_comments

  error: aborting due to 2 previous errors

  error: could not compile `sp-debug-derive`

@bkchr bkchr added A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders. labels Feb 2, 2021
@bkchr
Copy link
Member

bkchr commented Feb 2, 2021

bot merge

@ghost
Copy link

ghost commented Feb 2, 2021

Waiting for commit status.

@ghost ghost merged commit c7f52d1 into paritytech:master Feb 2, 2021
This pull request was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A2-insubstantial Pull request requires no code review (e.g., a sub-repository hash update). B0-silent Changes should not be mentioned in any release notes C1-low PR touches the given topic and has a low impact on builders.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants