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

Suggestion: Add whitespace check #95

Open
giuliazanchi opened this issue Feb 13, 2025 · 2 comments
Open

Suggestion: Add whitespace check #95

giuliazanchi opened this issue Feb 13, 2025 · 2 comments

Comments

@giuliazanchi
Copy link
Contributor

I'm proposing to add a check for white space linting errors that may be caught in the downstream repositories:

  • check that there are no trailing white spaces (e.g. . \n)
  • check that there is one and only one newline at the end of all files

An engineer in my team suggested running git rebase --whitespace=fix.

@giuliazanchi giuliazanchi changed the title Suggestion: Suggestion: Add whitespace check Feb 13, 2025
@giuliazanchi
Copy link
Contributor Author

@medubelko
Copy link
Contributor

Although it's very poorly documented, sphinx-lint has built-in checks for:

As an alternative, we could consider an autoformatter. Very few exist for rST. The Starcraft team will be testing docstrfmt in the near future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants