Skip to content

[Docs] Reduce callout noise in development.rst#61503

Open
andrew-anyscale wants to merge 1 commit intomasterfrom
andrew/revup/master/reduce-callouts
Open

[Docs] Reduce callout noise in development.rst#61503
andrew-anyscale wants to merge 1 commit intomasterfrom
andrew/revup/master/reduce-callouts

Conversation

@andrew-anyscale
Copy link
Contributor

Convert note/tip boxes to plain prose throughout the Python-only and full source build sections. Keep the two warning boxes (pip uninstall, setup.py install) and the Tune/RLlib tip since those warn about destructive actions or save significant time.

Topic: reduce-callouts
Relative: style-wheel-docs
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:
#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 8b479ba5 c804c62a diff Mar 4 15:00 PM 1 file changed, 2 insertions(+), 6 deletions(-)
1 7c2c92ef 1287b638 rebase Mar 4 15:03 PM 0 files changed
2 15b6ed37 2a080c4f rebase Mar 4 15:08 PM 0 files changed
3 0abe1e04 3a1a26e8 rebase Mar 4 15:19 PM 0 files changed
4 a9698feb 404f3511 diff Mar 5 9:31 AM 1 file changed, 1 insertion(+), 1 deletion(-)
5 2bb0a83e 9f135ad6 rebase Mar 5 9:34 AM 0 files changed
6 99a4c5ea 28443475 diff Mar 5 17:00 PM 0 files changed
7 3d9ba2f2 4a981403 rebase Mar 5 21:20 PM 0 files changed
8 34f3e087 1f3a82ee diff Mar 6 12:18 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 modifies doc/source/ray-contribute/development.rst to convert several .. note:: and .. tip:: directives into plain prose, with the goal of reducing visual noise in the development setup guide. The changes are consistent with the description, as important warnings and a specific tip are intentionally kept as callouts. The conversions to prose are done correctly, and no issues were found in these changes.

@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/reduce-callouts branch from 8b479ba to 7c2c92e Compare March 4, 2026 23:03
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from 1287b63 to 2a080c4 Compare March 4, 2026 23:08
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/reduce-callouts branch 2 times, most recently from 15b6ed3 to 0abe1e0 Compare March 4, 2026 23:19
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from 2a080c4 to 3a1a26e 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

python python/ray/setup-dev.py

.. note:: [Advanced] You can also optionally skip creating symbolic links for specific directories:
You can also optionally skip creating symbolic links for specific directories:

Choose a reason for hiding this comment

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

Suggested change
You can also optionally skip creating symbolic links for specific directories:
You can optionally skip creating symbolic links for specific directories:

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call-- pushing an update for this

@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from 3a1a26e to 404f351 Compare March 5, 2026 17:31
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/reduce-callouts branch from 0abe1e0 to a9698fe Compare March 5, 2026 17:31
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch from 404f351 to 9f135ad Compare March 5, 2026 17:34
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/reduce-callouts branch from a9698fe to 2bb0a83 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/reduce-callouts branch from 2bb0a83 to 99a4c5e Compare March 6, 2026 01:01
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/style-wheel-docs branch 2 times, most recently from 2844347 to 4a98140 Compare March 6, 2026 05:20
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/reduce-callouts branch from 99a4c5e to 3d9ba2f Compare March 6, 2026 05:20
Base automatically changed from andrew/revup/master/style-wheel-docs to andrew/revup/master/add-refs March 6, 2026 19:31
Base automatically changed from andrew/revup/master/add-refs to master March 6, 2026 19:33
Copy link
Collaborator

@aslonnie aslonnie left a comment

Choose a reason for hiding this comment

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

merge conflicts?

Convert note/tip boxes to plain prose throughout the Python-only and full source build sections. Keep the two warning boxes (pip uninstall, setup.py install) and the Tune/RLlib tip since those warn about destructive actions or save significant time.

Topic: reduce-callouts
Relative: style-wheel-docs
Signed-off-by: andrew <andrew@anyscale.com>
@andrew-anyscale andrew-anyscale force-pushed the andrew/revup/master/reduce-callouts branch from 3d9ba2f to 34f3e08 Compare March 6, 2026 20:18
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.

3 participants