fix docs: unindent blocks to allow copy pasting more easily #45432
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Lorenzo von Ritter <lorenzo.ritter@gmail.com>
|
Before and after screenshots below
|
aslonnie
reviewed
May 19, 2024
Comment on lines
644
to
652
| @ray.remote | ||
| def task_running_300_seconds(): | ||
| print("Start!") | ||
| time.sleep(300) | ||
|
|
||
| # Create 2 tasks | ||
| tasks = [task_running_300_seconds.remote() for _ in range(2)] | ||
| @ray.remote | ||
| class Actor: | ||
| def __init__(self): | ||
| print("Actor created") |
There was a problem hiding this comment.
this indentation does not look correct.
There was a problem hiding this comment.
Good catch, thanks @aslonnie ! Updated.
Signed-off-by: Lorenzo von Ritter <lorenzo.ritter@gmail.com>
anyscalesam
added
triage
|
@angelinalg can you shepherd this into and merge when ready? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
Inconsistent indents in code samples of the Getting Started section make it harder to copy paste the code. Since this is the entry point of many users, I corrected the wrong indents so that they can copy paste the code samples more easily.
I also removed some indents in logs for consistency.
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.