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 core docs #47004

Merged

Conversation

peytondmurray
Copy link
Contributor

Why are these changes needed?

Currently we have no linting on any part of the docs code. This PR runs pre-commit on the core docs.

This PR fixes the following issues:

trim trailing whitespace.................................................Failed
- hook id: trailing-whitespace
- exit code: 1
- files were modified by this hook

Fixing doc/source/ray-core/examples/overview.rst
Fixing doc/source/ray-core/scheduling/placement-group.rst
Fixing doc/source/ray-core/doc_code/streaming_generator.py
Fixing doc/source/ray-core/tasks.rst
Fixing doc/source/ray-core/actors/terminating-actors.rst
Fixing doc/source/ray-core/scheduling/ray-oom-prevention.rst
Fixing doc/source/ray-core/objects/serialization.rst
Fixing doc/source/ray-core/using-ray-with-jupyter.rst
Fixing doc/source/ray-core/doc_code/ray-dag.py
Fixing doc/source/ray-core/fault_tolerance/tasks.rst
Fixing doc/source/ray-core/actors.rst

fix end of files.........................................................Failed
- hook id: end-of-file-fixer
- exit code: 1
- files were modified by this hook

Fixing doc/source/ray-core/user-spawn-processes.rst
Fixing doc/source/ray-core/api/cli.rst
Fixing doc/source/ray-core/images/oom_killer_example_killed_two.svg
Fixing doc/source/ray-core/examples/lm/preprocess.sh
Fixing doc/source/ray-core/examples/plot_hyperparameter.ipynb
Fixing doc/source/ray-core/patterns/concurrent-operations-async-actor.rst
Fixing doc/source/ray-core/images/oom_killer_example_killed_one.svg
Fixing doc/source/ray-core/images/memory.svg
Fixing doc/source/ray-core/actors/terminating-actors.rst
Fixing doc/source/ray-core/scheduling/resources.rst
Fixing doc/source/ray-core/images/oom_killer_example.svg
Fixing doc/source/ray-core/accelerator-types.rst
Fixing doc/source/ray-core/examples/images/batch-training.svg
Fixing doc/source/ray-core/images/physical_resources_vs_logical_resources.svg
Fixing doc/source/ray-core/images/pong-arch.svg
Fixing doc/source/ray-core/fault_tolerance/actors.rst
Fixing doc/source/ray-core/examples/images/automl.svg
Fixing doc/source/ray-core/examples/BUILD

check for added large files..............................................Passed
check python ast.........................................................Passed
check json...............................................................Passed
check toml...........................................(no files to check)Skipped
black....................................................................Passed
flake8...................................................................Passed
prettier.............................................(no files to check)Skipped
mypy.................................................(no files to check)Skipped
isort (python)...........................................................Passed
rst directives end with two colons.......................................Passed
rst ``inline code`` next to normal text..................................Failed
- hook id: rst-inline-touching-normal
- exit code: 1

doc/source/ray-core/actors.rst:427:Ray tracks all child and Actor Tasks. When the``recursive=True`` argument is given,

use logger.warning(......................................................Passed
check for not-real mock methods..........................................Passed
ShellCheck v0.9.0........................................................Passed
clang-format.........................................(no files to check)Skipped
Google Java Formatter................................(no files to check)Skipped
Check for Ray docstyle violations........................................Passed
Check for Ray import order violations....................................Passed

Related issue number

Part of #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 peytondmurray requested a review from a team as a code owner August 7, 2024 21:49
@peytondmurray peytondmurray requested a review from a team August 14, 2024 20:28
@peytondmurray peytondmurray added docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Aug 14, 2024
@jjyao jjyao added the go add ONLY when ready to merge, run all tests label Aug 17, 2024
@aslonnie aslonnie merged commit 579995c into ray-project:master Aug 27, 2024
5 checks passed
@peytondmurray peytondmurray deleted the 42587-pre-commit-doc-core branch August 27, 2024 00:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Issues that should be addressed in Ray Core docs An issue or change related to documentation go add ONLY when ready to merge, run all tests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants