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

[AIR][DOC] Improved code snippet from TorchCheckpoint, removed angle brackets, and assert outputs #30791

Merged
merged 6 commits into from
Dec 6, 2022

Conversation

dmatrix
Copy link
Contributor

@dmatrix dmatrix commented Nov 30, 2022

Signed-off-by: Jules Damji [email protected]

  • As part of on-going effort to make code snippets runnable
  • Use testcode and testoput for CI
  • Assert output

Checks

  • [x ] I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • [ x] I've run scripts/format.sh to lint the changes in this PR.

@dmatrix dmatrix changed the title [AIR][DOC] Improved code snippet from TorchCheckpoint, removed angel brackets, and assert outputs [AIR][DOC] Improved code snippet from TorchCheckpoint, removed angle brackets, and assert outputs Nov 30, 2022
Copy link
Contributor

@pcmoritz pcmoritz left a comment

Choose a reason for hiding this comment

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

Thanks, looks great! There is still a little convincing of the CI to do I think before we can merge it :)

@pcmoritz
Copy link
Contributor

pcmoritz commented Dec 2, 2022

Is it possible that the CI wants you to do

            .. testoutput::
                :hide:
                :options: +ELLIPSIS

instead of

            .. testoutput::
            :hide:
            :options: +ELLIPSIS

?

Jules Damji added 2 commits December 1, 2022 17:36
…cts output and ignores it with ELLIPSIS option

Signed-off-by: Jules Damji <[email protected]>
@dmatrix
Copy link
Contributor Author

dmatrix commented Dec 5, 2022

@pcmoritz a bit weird that all local doctest pass, but somehow the ci-build-pr buildkite fails.... adding and removing the same lines ??

@pcmoritz pcmoritz merged commit 6b638c9 into master Dec 6, 2022
@pcmoritz pcmoritz deleted the br_jsd_improve_code_snippets_pr_4 branch December 6, 2022 03:09
WeichenXu123 pushed a commit to WeichenXu123/ray that referenced this pull request Dec 19, 2022
…brackets, and assert outputs (ray-project#30791)

Signed-off-by: Jules Damji [email protected]

As part of on-going effort to make code snippets runnable: Use testcode and testoput for CI

Signed-off-by: Weichen Xu <[email protected]>
tamohannes pushed a commit to ju2ez/ray that referenced this pull request Jan 25, 2023
…brackets, and assert outputs (ray-project#30791)

Signed-off-by: Jules Damji [email protected]

As part of on-going effort to make code snippets runnable: Use testcode and testoput for CI

Signed-off-by: tmynn <[email protected]>
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