Skip to content
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.

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

Remove trailing whitespace in markdown #8112

Closed
4 tasks done
robert-zaremba opened this issue Dec 8, 2020 · 5 comments · Fixed by #9353
Closed
4 tasks done

Remove trailing whitespace in markdown #8112

robert-zaremba opened this issue Dec 8, 2020 · 5 comments · Fixed by #9353
Assignees
Labels
Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.

Comments

@robert-zaremba
Copy link
Collaborator

robert-zaremba commented Dec 8, 2020

Summary

Leaving trailing an whitespace in a code causes useless diffs. It's also not good for a code style.

  • make lint should fail if there are trailing whitespaces
  • make lint-fix should remove trailing whitespaces

Problem Definition

#8107 (review)


For Admin Use

  • Not duplicate issue
  • Appropriate labels applied
  • Appropriate contributors tagged
  • Contributor assigned/self-assigned
@robert-zaremba robert-zaremba self-assigned this Dec 8, 2020
@robert-zaremba robert-zaremba added the Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity. label Dec 8, 2020
@tac0turtle
Copy link
Member

this seems specific to markdown not code, am I missing something?

@alexanderbez
Copy link
Contributor

I think @robert-zaremba means the markdown file(s). Yah, we should have a linter. It's annoying to keep fixing these in PRs.

@tac0turtle
Copy link
Member

On tendermint we use githubs super linter: https://github.com/tendermint/tendermint/blob/master/.github/workflows/linter.yml with markdown linting.

@alessio
Copy link
Contributor

alessio commented Dec 8, 2020

@marbar3778 does that just raise warnings? Could it fix them too?

@tac0turtle
Copy link
Member

raise warnings, we use https://github.com/igorshubovych/markdownlint-cli to fix them

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Code Hygiene General cleanup and restructuring of code to provide clarity, flexibility, and modularity.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants