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

[Docs] Revise "How to write code snippets" #35066

Merged
merged 1 commit into from
May 5, 2023

Conversation

bveeramani
Copy link
Member

Why are these changes needed?

This PR adds instructions on how to illustrate outputs when your example is non-deterministic. It also makes some minor revisions.

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: Balaji Veeramani <[email protected]>
@bveeramani bveeramani requested a review from a team as a code owner May 5, 2023 05:55
@ericl ericl merged commit 91993ad into ray-project:master May 5, 2023
architkulkarni pushed a commit to architkulkarni/ray that referenced this pull request May 16, 2023
This PR adds instructions on how to illustrate outputs when your example is non-deterministic. It also makes some minor revisions.
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.

None yet

3 participants