Skip to content

[Docs] Apply Google style guide to development.rst#61502

Merged
aslonnie merged 1 commit intoandrew/revup/master/add-refsfrom
andrew/revup/master/style-wheel-docs
Mar 6, 2026
Merged

[Docs] Apply Google style guide to development.rst#61502
aslonnie merged 1 commit intoandrew/revup/master/add-refsfrom
andrew/revup/master/style-wheel-docs

Conversation

@andrew-anyscale
Copy link
Contributor

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

@andrew-anyscale andrew-anyscale requested a review from a team as a code owner March 4, 2026 23:00
@andrew-anyscale
Copy link
Contributor Author

andrew-anyscale commented Mar 4, 2026

Reviews in this chain:
#61501 [Docs] Add path-chooser, fix cross-references, and reorganize tips
 └#61502 [Docs] Apply Google style guide to development.rst
  └#61503 [Docs] Reduce callout noise in development.rst
   └#61504 [Docs] Add distributable manylinux wheel build path to development.rst

@andrew-anyscale
Copy link
Contributor Author

andrew-anyscale commented Mar 4, 2026

# head base diff date summary
0 c804c62a 7a39e957 diff Mar 4 15:00 PM 1 file changed, 58 insertions(+), 59 deletions(-)
1 1287b638 2b82c0b0 diff Mar 4 15:03 PM 1 file changed, 1 insertion(+), 1 deletion(-)
2 2a080c4f 9e5f42c8 diff Mar 4 15:08 PM 1 file changed, 1 insertion(+), 3 deletions(-)
3 3a1a26e8 7a51cf6e diff Mar 4 15:19 PM 1 file changed, 3 insertions(+), 1 deletion(-)
4 404f3511 7a51cf6e diff Mar 5 9:31 AM 1 file changed, 1 insertion(+), 1 deletion(-)
5 9f135ad6 7a51cf6e diff Mar 5 9:34 AM 1 file changed, 1 insertion(+), 1 deletion(-)
6 28443475 7a51cf6e diff Mar 5 17:00 PM 1 file changed, 6 insertions(+), 8 deletions(-)
7 4a981403 87b91a3d rebase Mar 5 21:20 PM 0 files changed

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/add-refs branch from 7a39e95 to 2b82c0b Compare March 4, 2026 23:03
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from c804c62 to 1287b63 Compare March 4, 2026 23:03
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/add-refs branch from 2b82c0b to 9e5f42c Compare March 4, 2026 23:08
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch 2 times, most recently from 2a080c4 to 3a1a26e Compare March 4, 2026 23:19
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/add-refs branch from 9e5f42c to 7a51cf6 Compare March 4, 2026 23:19
Copy link

@ronny-anyscale ronny-anyscale left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

.. _building-ray:

Building Ray from Source
Building Ray from source
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Solid! Pushing update for this

.. _building-ray:

Building Ray from Source
Building Ray from source
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's aim for sentence case for all headers, including H1s. Agree we're definitely not there today.

@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch 2 times, most recently from 404f351 to 9f135ad Compare March 5, 2026 17:34
@andrew-anyscale andrew-anyscale requested a review from aslonnie March 5, 2026 19:14
@andrew-anyscale andrew-anyscale added the go add ONLY when ready to merge, run all tests label Mar 5, 2026
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from 9f135ad to 2844347 Compare March 6, 2026 01:01
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>
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from 2844347 to 4a98140 Compare March 6, 2026 05:20
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/add-refs branch from 7a51cf6 to 87b91a3 Compare March 6, 2026 05:20
@aslonnie aslonnie merged commit 512d462 into andrew/revup/master/add-refs Mar 6, 2026
5 checks passed
@aslonnie aslonnie deleted the andrew/revup/master/style-wheel-docs branch March 6, 2026 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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