Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[Doc] Make doc code snippet testable [6/n] #36942

Merged
merged 25 commits into from
Jul 7, 2023
Merged

[Doc] Make doc code snippet testable [6/n] #36942

merged 25 commits into from
Jul 7, 2023

Conversation

jjyao
Copy link
Collaborator

@jjyao jjyao commented Jun 29, 2023

Why are these changes needed?

Change code snippet from ..code-block:: to ..testcode::

Related issue number

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

jjyao added 17 commits June 29, 2023 15:52
@jjyao
Merge branch 'master' of github.com:ray-project/ray into jjyao/untest
3c7ca34
@jjyao
up
0c33973 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
f6841a4 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
up
f75c1e8 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
72c4d04 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
6729cf3 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
649acf2 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
1f224d6 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
Merge branch 'master' of github.com:ray-project/ray into jjyao/untest
903683d
@jjyao
try
ec08035 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
b840d70 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
71d8cb2 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
da00699 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
a3c3ec8 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
21c8766 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
22cf7b1 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
90a001c 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
try
8391b38 
Signed-off-by: Jiajun Yao <[email protected]>
@fishbone fishbone removed their assignment Jul 6, 2023
jjyao added 3 commits July 6, 2023 11:05
@jjyao
try
7fcda33 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
fix
66be467 
Signed-off-by: Jiajun Yao <[email protected]>
@jjyao
up
adb1c75 
Signed-off-by: Jiajun Yao <[email protected]>
bveeramani
bveeramani reviewed Jul 6, 2023
View reviewed changes
doc/BUILD Outdated Show resolved Hide resolved
doc/BUILD Outdated Show resolved Hide resolved
doc/source/workflows/basics.rst Outdated Show resolved Hide resolved
doc/source/workflows/basics.rst Show resolved Hide resolved
doc/source/workflows/events.rst Outdated Show resolved Hide resolved
doc/source/workflows/events.rst Show resolved Hide resolved
python/ray/workflow/http_event_provider.py Outdated Show resolved Hide resolved
@jjyao
comments
867c75e 
Signed-off-by: Jiajun Yao <[email protected]>
bveeramani
bveeramani approved these changes Jul 7, 2023
View reviewed changes
Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

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

LGTM!

@jjyao jjyao merged commit b56aab4 into ray-project:master Jul 7, 2023
@jjyao jjyao deleted the jjyao/untest branch July 7, 2023 16:34
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
@jjyao @arvind-chandra
[Doc] Make doc code snippet testable [6/n] (ray-project#36942)
4467ce0 
Change code snippet from ..code-block:: to ..testcode::

Signed-off-by: Jiajun Yao <[email protected]>
Signed-off-by: e428265 <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@angelinalg angelinalg angelinalg approved these changes

@fishbone fishbone fishbone approved these changes

@bveeramani bveeramani bveeramani approved these changes

@ericl ericl Awaiting requested review from ericl

@stephanie-wang stephanie-wang Awaiting requested review from stephanie-wang stephanie-wang is a code owner

@suquark suquark Awaiting requested review from suquark

@maxpumperla maxpumperla Awaiting requested review from maxpumperla maxpumperla is a code owner

Assignees

@ericl ericl

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@jjyao @bveeramani @fishbone @angelinalg @ericl