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

[Doc] Run pre-commit on docs #42589

Closed

Conversation

peytondmurray
Copy link
Contributor

@peytondmurray peytondmurray commented Jan 23, 2024

Why are these changes needed?

This PR runs the pre-commit hooks on the docs/ subdirectory. The changes you see here include

  • Removing useless whitespace at the end of lines and on blank lines
  • Adding newline characters at the end of files
  • Applying prettier formatting to html/js/css
  • I modified .prettierrc.toml to not put semicolons at the end of js lines. We're being inconsistent here anyway
  • Fixed an issue with the CSAT widget where two <span> elements had no closing tags; this was picked up by prettier
  • Fixed two cases where double-backticks were touching non-whitespace in RST files.

Related issue number

Closes #42587.

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: pdmurray <peynmurray@gmail.com>
@peytondmurray
Copy link
Contributor Author

After a discussion, I'm going to break this PR into small bits to minimize code owner impact. Closing.

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

Successfully merging this pull request may close these issues.

[Doc] Run pre-commit hooks on doc/
1 participant