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

[workflow] Update workflow doc and examples #24804

Merged
merged 3 commits into from
May 16, 2022

Conversation

suquark
Copy link
Member

@suquark suquark commented May 14, 2022

Why are these changes needed?

This doc update includes:

  1. Use workflow.options inside .options. Previously these are not working.
  2. Remove unnecessary workflow.init in the examples.

Checks

  • 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 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 :(

@suquark
Copy link
Member Author

suquark commented May 16, 2022

The CI error in Lint is


Warning, treated as error:
--
  | /ray/doc/source/data/package-ref.rst:128:Title underline too short.

I think this is unrelated to this PR. I'll merge it.

@suquark suquark merged commit 2766284 into ray-project:master May 16, 2022
@suquark suquark deleted the workflow_doc branch May 16, 2022 22:41
maxpumperla pushed a commit that referenced this pull request May 18, 2022
* update doc of workflow options

* update examples and make sure they are working
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

2 participants