[Docs] Apply Google style guide to development.rst#61502
[Docs] Apply Google style guide to development.rst#61502aslonnie merged 1 commit intoandrew/revup/master/add-refsfrom
Conversation
|
There was a problem hiding this comment.
Code Review
This pull request applies the Google developer documentation style guide to development.rst, improving readability and consistency. The changes include using sentence case for headings, adopting the second person and active voice, using present tense and contractions, and correcting macOS branding. The modifications are well-executed and significantly enhance the quality of the documentation. I have one minor suggestion to further improve consistency in the description of environment variables.
7a39e95 to
2b82c0b
Compare
c804c62 to
1287b63
Compare
2b82c0b to
9e5f42c
Compare
2a080c4 to
3a1a26e
Compare
9e5f42c to
7a51cf6
Compare
| .. _building-ray: | ||
|
|
||
| Building Ray from Source | ||
| Building Ray from source |
There was a problem hiding this comment.
Let's aim for sentence case for all headers, including H1s. Agree we're definitely not there today.
| pip install -U https://s3-us-west-2.amazonaws.com/ray-wheels/latest/ray-3.0.0.dev0-cp310-cp310-manylinux2014_x86_64.whl | ||
|
|
||
| 4. Replace Python files in the installed package with your local editable copy. We provide a simple script to help you do this: ``python python/ray/setup-dev.py``. Running the script will remove the ``ray/tune``, ``ray/rllib``, ``ray/autoscaler`` dir (among other directories) bundled with the ``ray`` pip package, and replace them with links to your local code. This way, changing files in your git clone will directly affect the behavior of your installed Ray. | ||
| 4. Replace Python files in the installed package with your local editable copy. Use the script ``python python/ray/setup-dev.py`` to do this. The script removes the ``ray/tune``, ``ray/rllib``, ``ray/autoscaler`` dir (among other directories) bundled with the ``ray`` pip package, and replaces them with links to your local code. This way, changing files in your git clone directly affects the behavior of your installed Ray. |
There was a problem hiding this comment.
| 4. Replace Python files in the installed package with your local editable copy. Use the script ``python python/ray/setup-dev.py`` to do this. The script removes the ``ray/tune``, ``ray/rllib``, ``ray/autoscaler`` dir (among other directories) bundled with the ``ray`` pip package, and replaces them with links to your local code. This way, changing files in your git clone directly affects the behavior of your installed Ray. | |
| 4. Replace Python files in the installed package with your local editable copy. Use the script ``python python/ray/setup-dev.py`` to do this. The script removes the ``ray/tune``, ``ray/rllib``, ``ray/autoscaler`` directories (among others) bundled with the ``ray`` pip package, replacing them with links to your local code. This way, changing files in your git clone directly affects the behavior of your installed Ray. |
There was a problem hiding this comment.
Solid! Pushing update for this
| .. _building-ray: | ||
|
|
||
| Building Ray from Source | ||
| Building Ray from source |
There was a problem hiding this comment.
Let's aim for sentence case for all headers, including H1s. Agree we're definitely not there today.
404f351 to
9f135ad
Compare
9f135ad to
2844347
Compare
Apply Google developer documentation style guide rules to development.rst:
- Sentence case: fix 11 headings (Source, Steps, Only, Full Source Build, MacOS, Development Tooling, Pre-commit Hooks, Advanced Build Options, Fast/Debug/Optimized Builds, Building the Docs)
- Second person: replace "We provide" with "Use the script"
- Present tense: replace future "will" constructions throughout (env var list, prose sections)
- Contractions: "Do not" -> "Don't", "will not" -> "won't", "pip is not" -> "isn't"
- Active voice: env var list passive constructions converted ("will be built" -> "Ray builds", etc.)
- macOS branding: fix "MacOS" -> "macOS" and "mac" -> "Mac" throughout
Topic: style-wheel-docs
Relative: add-refs
Signed-off-by: andrew <andrew@anyscale.com>
2844347 to
4a98140
Compare
7a51cf6 to
87b91a3
Compare
Apply Google developer documentation style guide rules to development.rst:
Topic: style-wheel-docs
Relative: add-refs
Signed-off-by: andrew andrew@anyscale.com