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.

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

[Doc] Make doc code snippet testable [8/n] #36963

Merged
merged 1 commit into from
Jun 29, 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 :(

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
@jjyao jjyao requested a review from a team as a code owner June 29, 2023 20:14
@jjyao jjyao merged commit f4b91ca into ray-project:master Jun 29, 2023
@jjyao jjyao deleted the jjyao/codeblock branch June 29, 2023 22:51
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
Change code snippet from ..code-block:: to ..testcode::

Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants