Skip to content

[doc][core] fix reStructuredText formatting on Resources page #53882

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

Merged
merged 1 commit into from
Jul 2, 2025

Conversation

davidxia
Copy link
Contributor

@davidxia davidxia commented Jun 17, 2025

reStructuredText doesn't support nested inline markup like bold and monospace at the same time. So we move the double backticks outside of the bold markup.

currently looks like https://docs.ray.io/en/latest/ray-core/scheduling/resources.html#specifying-node-resources

image

@davidxia davidxia marked this pull request as ready for review June 17, 2025 12:31
@davidxia davidxia requested a review from a team as a code owner June 17, 2025 12:31
Copy link
Contributor

@dstrodtman dstrodtman left a comment

Choose a reason for hiding this comment

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

An alternate suggestion for the fix, but either way is fine.

reStructuredText doesn't support nested inline markup like bold and monospace
at the same time. So we move the double backticks outside of the bold markup.

Signed-off-by: David Xia <david@davidxia.com>
@davidxia
Copy link
Contributor Author

@dstrodtman went with your suggestion. Ready for another review and merge whenever you have time. Thanks!

@dayshah
Copy link
Contributor

dayshah commented Jul 2, 2025

@edoakes / @jjyao for merge

@dayshah dayshah added the go add ONLY when ready to merge, run all tests label Jul 2, 2025
@edoakes edoakes enabled auto-merge (squash) July 2, 2025 20:39
@edoakes edoakes merged commit c3cf63a into ray-project:master Jul 2, 2025
7 checks passed
@davidxia davidxia deleted the docs4 branch July 3, 2025 06:34
elliot-barn pushed a commit that referenced this pull request Jul 7, 2025
reStructuredText doesn't support nested inline markup like bold and
monospace at the same time. So we move the double backticks outside of
the bold markup.

currently looks like
https://docs.ray.io/en/latest/ray-core/scheduling/resources.html#specifying-node-resources

<img width="707" alt="image"
src="https://github.com/user-attachments/assets/8ea43328-24f8-4591-a58e-65df53eecb18"
/>

Signed-off-by: David Xia <david@davidxia.com>
Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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